ドキュメント書きのコツを自分なりにまとめてみる

最近ドキュメントを書く仕事が多くなってきた.毎回「うーん」と悩むのはイヤなのでコツをまとめておくことにする.非常に分かりやすいページがあったので,こちらからピックアップして自分なりに解釈してみる.
参考サイト:ちょっとした構成案を作れば、あなたのドキュメントはもっとわかりやすくなる!


さて,スタート.

構成案を作成するにあたっては、前提条件として、以下のようなことを整理し、確認しておきましょう。

最初に行うこととして以下を整理しておく,とのこと.

  • 対象の読者は誰
  • 経験や知識の量
  • マニュアルの目的

このように具体的なユーザー(利用者)像を思い浮かべ、どのようなシーンで、どう使うかを、構成案をまとめる前に、メモとして書き出しおくと情報整理に役立ちます。

書くべきポイントが絞れて,「書かなくて良いこと」「さっと流して良い部分」「ここはちゃんと書くべきポイント」が明確になる感じか.


以上が確認できたら,次は構成案を考える.その前に「構成案」って何だ?

構成案とは
手順書やマニュアルに記載する項目を見出しレベルで書き出し、目次のような体裁でまとめたもの

なるほど.さてさて.

読み手がどのように使うのか確認の段階で整理したら、具体的に項目を書き出し、構成案を作成しましょう。項目を洗い出しして、並べ、組み立てていきます。

これは経験上,マインドマップを使うとボワっとイメージが膨らんだり,項目同士の繋がり見えるので良かった.

利用者が実際に操作する手順や、利用のフローに従って組み立てると、読み手は次にどのようなことをすべきなのかがわかり、迷わずにすみます。

わかりやすい構成にするには、全体から詳細へと項目を組み立てることも重要です。概要や前提となる知識については、先にまとめ、全体像を伝えてから、各論の説明に入ります。補足などはその後に入れます。

  • 読み手の立場で考える
  • 概要・前提知識 → 全体像 → 詳細 → 補足,の流れ

という感じか.