目次

手順書の書き方

操作手順書

マニュアル執筆が怖くなくなる、12の執筆ポイント

操作マニュアルを記述する

  1. 読み手に分かりやすい流れを考える
  2. 操作手順は「画面→説明文」で書く
  3. 操作結果は「説明文→画面」で書く
  4. 操作手順と結果説明は、明確に分離して記述する
  5. すべての画面をきちんと記述する
  6. 主語はユーザー？ システム？ 主語の表現を区別する
  7. 時間軸に沿って業務の流れを記述する
  8. 業務で行う作業を漏れなく記述する
  9. 操作マニュアルと正確に関連付ける
  10. ユーザー側独特の用語・表現に注意する

障害対応マニュアルを記述する

  1. ユーザーが障害状況を判断できる表現にする
  2. 自力解決できない障害も書いておく

その他