解説
操作手順は、利用者が実際に手を動かす単位で区切って並べた工程です。手順書が文書そのものを指すのに対し、操作手順は手順書の中身にあたる工程の連なりを指します。FAQ記事の読み手は、操作手順に沿って実際に画面を操作します。そのため、操作手順の記述が実際の画面とずれていると、記事全体が信用されなくなります。
判断基準
利用環境が分かれる場合は、操作手順も環境ごとに分けて書きます。同じ操作でも、iPhoneとAndroid、ブラウザ版とアプリ版では、画面も導線も異なるためです。1本の手順に「※アプリ版の場合は」という注記を重ねるほど、読み手は自分に関係のない行を読み飛ばす負担が増えます。したがって、環境ごとに見出しやタブで分け、読み手が自分に該当する1本だけを追える形にします。分岐が少ない場合は注記で足りることもありますが、3つ以上になる場合は、記事そのものを分けたほうが読みやすくなります。
実務での使われ方
操作手順では、操作する場所とボタン名を具体的に書きます。たとえば、「設定画面から変更します」ではなく、「画面右上の【設定】を押します」のように書きます。GoogleやMicrosoftの技術文書のスタイルガイドでも、操作の内容より先に、操作する場所を示す書き方が推奨されています。さらに、画面が複雑な場合は、該当箇所を囲んだスクリーンショットを添えます。
注意点
スクリーンショットは、更新の手間まで見込んで入れます。画像は分かりやすい反面、画面が変わるたびに撮影し、差し替える作業が必要になるためです。そのため、ボタンの位置や名称がよく変わる箇所は、画像に頼らず文章で書いておくほうが、記事の内容が古くなりにくくなります。また、リリースのたびに全記事の画像を点検するのは現実的ではありません。したがって、どの画面を撮影した画像かを記事側に控えておくと、差し替えが必要な記事を絞り込めます。
該当する用語がありません