Zagromgi読む人のスタート地点を揃える
同じ操作でも、初めて担当する人と日常的に使う人では必要な説明が違います。まず利用者の役割、作業の目的、操作する環境を整理します。現行の説明資料に加え、実際の画面や担当者が困りやすい箇所を共有してください。情報が複数のファイルに分かれていても、内容の関係を確認するところから始められます。
一つの手順に、一つの判断を置く
操作を長い文章にまとめず、作業前の条件、行う操作、画面上で確認する結果を順に組み立てます。分岐する操作は共通部分から分け、例外は該当する手順の近くへ配置します。用語の表記を揃え、ボタン名と説明文が食い違わないように原稿と画面を照合します。
画面と文章を一緒に確認する
初稿では章立てと代表的な手順を確認し、説明の細かさを決めます。お客さまには実際の業務に沿って操作が成立するかを確認いただき、その結果を本文と注記へ反映します。操作画面が変わる場合は対象の版を揃えてから修正範囲を整理します。
引き渡すものを決める
納品する原稿、画像、PDFやWeb用データの範囲は、利用する場所と更新方法に合わせて決めます。公開先の設定やアクセス権限は制作内容と分けて確認します。完成後に担当者が直す箇所がある場合は、編集できる元データの形式も最初に相談します。
