分かりやすいソフトウェア操作手順の書き方

分かりやすいソフトウェアのビジュアルドキュメントは、何を、どこで行い、成功をどう確認するかを読者に伝えます。完成状態を1つ決め、画面どおりのラベルを使った直接的な操作を書き、確認ポイントを加え、役立つスクリーンショットと組み合わせます。最後に、口頭で説明せずにガイドを試してください。

要点： 各ステップを操作から始め、画面に見える項目名、必要な値や条件、次へ進めると判断できる結果を書きます。

完成状態を1つ決める

完成状態を決めると、各ステップが必要な理由が明確になります。「ガイドをPNGファイルで書き出す」「Shotomaticの画面収録権限を有効にする」のように、読者が完了して確認できる作業として書きます。

「エディターを理解する」のような広い目標は避けてください。何を含めるべきか書き手が判断できず、読者もいつ完了したか分かりません。

各ステップを操作から始める

最初の文で、読者が何をするか伝えます。「開く」「選ぶ」「入力する」「ドラッグする」「確認する」「書き出す」など、直接的な動詞から始めてください。

次の2つを比べます。

修正前：「書き出しメニューは右上にあり、便利な形式がいくつか含まれています。」

修正後：「右上のExportメニューを開きます。」

修正後なら、読者はすぐに操作できます。形式の説明は、選択に影響する場合だけ後へ続けます。

画面どおりのラベルを使う

正確なラベルがあれば、読者は説明と現在の画面を対応させられます。画面の大文字・小文字を保ち、操作が異なる場合は、メニュー、ボタン、入力欄、タブ、キーボードショートカットを区別してください。

修正前：「設定画面へ移動し、必要な権限をオンにします。」

修正後：「システム設定 > プライバシーとセキュリティ > 画面とシステムオーディオの収録を開き、Shotomaticを有効にします。」

読者から見えない製品内部の名前は避けます。開発者／管理者向けと明記された文書を除き、公開されている画面に合わせて書いてください。

1ステップに1つの判断を書く

1つのステップには、1つの意味のある操作または判断を含めます。問題が起きた場所を探しやすくなり、スクリーンショットも対応させやすくなります。

密接に関係する入力と確定は、同じステップに残せます。

Document titleにQuarterly reviewと入力し、Saveを選びます。

一方の操作だけに別の警告、期待する結果、分岐がある場合は、ステップを分けます。

重要な操作の後に確認ポイントを置く

確認ポイントがあれば、操作が成功したか読者が判断できます。権限変更、アップロード、書き出し、招待、破壊的な操作、時間がかかる画面遷移の後に使ってください。

修正前：「Export PDFを選んで続けます。」

修正後：「Export PDFを選びます。保存ダイアログが開いたら、保存先フォルダを選びます。」

この確認があれば、アプリが前の画面に残っている間に保存先を探し始めずに済みます。

目で確認できる条件から分岐を書く

分岐は、読者が見たり確認したりできる条件から始めます。通常の手順を先に書き、例外は影響するステップの近くに置いてください。

修正前：「必要に応じて権限を調整します。」

修正後：「ウィンドウのプレビューが空白なら、システム設定 > プライバシーとセキュリティ > 画面とシステムオーディオの収録を開き、Shotomaticが有効か確認します。」

まれな例外をすべて主なガイドへ追加しないでください。複数の症状と原因で作業が中断される場合は、トラブルシューティング専用ページへリンクします。

場所と状態はスクリーンショットで示す

文章と画像で役割を分けます。文章では、操作、必要な値、条件、期待する結果を伝えます。スクリーンショットでは、操作項目の場所と関連する画面状態を示します。

画面に見えるすべての要素を文章で説明するのは避けてください。画像全体に大きな文章を重ね、指示をすべて画像へ入れるのも避けます。画像を表示できない、または見にくい読者も、操作を理解できるようにします。

クリックマーカー、矢印、図形、テキスト、切り抜き、ぼかしの選び方は、Macで分かりやすい操作手順用スクリーンショットに注釈を付ける方法をご覧ください。

不要な言葉と暗黙の前提を取り除く

不要な言葉は操作を遅らせ、暗黙の前提は読者の作業を止めます。「簡単に」「ただ」「いつもどおり」「必要に応じて設定」などの表現を削り、不足する条件に置き換えてください。

修正前：「必要に応じて書き出し設定を簡単に調整します。」

修正後：「PNGを選び、Original sizeを維持して、サポートチケットの証拠を保存するフォルダを指定します。」

修正後のほうが長いのは、読者に必要な情報が入っているからです。簡潔さとは、必要な内容を消すことではなく、使わない言葉を除くことです。

口頭説明なしで手順を試す

ガイド作成に関わっていない人に試してもらいます。説明に書かれた開始条件だけを渡し、口頭で修正せずに作業を完了してもらってください。

最初に迷った場所、間違った操作項目を選んだ場所、予期しない画面になった場所を記録します。その地点の文章またはスクリーンショットを直し、最初からもう一度試します。

読者が決めた完成状態に到達し、すべての分岐を目で確認でき、書き手の記憶に頼らず進められれば完成です。クリック撮影の全手順は、Macでクリックからステップ形式のガイドを作る方法をご覧ください。現在のAction Captureツールも確認できます。