ドキュメントを書き始める前に全体の骨子を組み立てる。ドキュメントを書いた後、自分でしっかりと推敲する――。どちらも、速く読めて理解が一致する文章を書くために必要です。本講座では、骨子の組み立てと推敲の方法を解説します。
関連講座：開発ドキュメントの悪文修正術［箇条書き］
連載
開発ドキュメントの悪文修正術［骨子と推敲］
目次
-
第1回 「目的」がはっきりしたドキュメントを作る
プロジェクトやシステム構築の目的を明確にする
ITエンジニアはシステムをどうやって何を作るのかという点にばかり目が向きがちで、何のためにシステムを構築するのかという目的について関心が薄い場合があります。プロジェクトやシステム構築の目的が分かりにくい開発ドキュメントをしばしば見かけます。
-
第2回 「三角ロジック」で文書の納得感を高める
主張を裏付ける「事実」と「根拠」を整理する
開発現場のドキュメントを読んでいると、書かれている主張が「本当にそうなの？」と疑わしく感じることがあります。主張に納得感がなければ、文章そのものが意味を成さないでしょう。
-
第3回 複雑な文章をすっきりさせる推敲のコツ
階層構造で目的と手段を整理
文章を書いていると、「あれも大事、これも大事」といった具合に、いろいろな事柄を書き足したくなるものです。特にプロジェクト構想書、要件定義書、仕様書など設計より上流の工程で作成するドキュメントでは、書いているうちに文章が肥大化してしまうことが少なくありません。
