全2711文字

 ドキュメントを書き始める前に、全体の構成を組み立てる。ドキュメントを書いた後、自分でしっかりと見直す―。どちらも、信頼される開発者として不可欠な行動習慣です。

 前者は骨子(スケルトン)の組み立て、後者は推敲と呼びます。これらは面倒なことに思えるかもしれません。しかし、速く読めて理解が一致する文章を書くために、ぜひ徹底したいことです。

 利点はそれだけではありません。骨子の組み立てをしっかり行えば、文章を書いている途中で構成を変更することがなくなります。つまり文章を書く作業が楽になるのです。また、自分で書いた文章を推敲することによって、気付きが生まれ、文章を書くスキルが高まります。

 「開発ドキュメントの悪文修正術」シリーズの最終回となる本講座では、骨子の組み立てと推敲について学びます。いつものように題材としてよくある文例を挙げ、それを推敲して、骨子を組み立て直します。

 取り上げるポイントは次の四つです。

  • (Ⅰ)目的を盛り込む
  • (Ⅱ)三角ロジックを活用する
  • (Ⅲ)階層構造で目的と手段を整理
  • (Ⅳ)一晩寝かせてチェックする

 以降で、これらのポイントを順に見ていきましょう。