タグ

manualとHowToに関するsyqueのブックマーク (1)

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

    前回「『目次』の良し悪しが、すべてのマニュアルの良し悪しを決める」に引き続き、分かりやすいユーザーマニュアルの作成ポイントを説明します。前回は「構成」について説明しました。今回は「表現方法」についてです。 「操作マニュアル」「業務マニュアル」「障害対応マニュアル」 について、全部で12のポイントを解説します。 操作マニュアルを記述する 1.読み手に分かりやすい流れを考える ユーザーが操作マニュアルから知りたいことは「操作手順」と「操作の結果」です。 操作マニュアルでは、これらの情報を、「画面のイメージ」と「説明文」の組み合わせで表現します。 + 操作の結果 操作の結果を表示する画面 処理内容や操作結果を説明する文章 ただし、一般的にシステムの操作は、次のような流れになります。 表示されている画面で操作を行う ↓ 結果の画面に遷移し、新たな画面が表示される≫ ↓ 表示されている画面で次の操作

    マニュアル執筆が怖くなくなる、12の執筆ポイント
    syque
    syque 2010/10/20
    画面を先に見せる、手順と結果を対にする、ユーザは能動でシステムは受動 | あと別に怖くない
  • 1