エンジニアが一生困らない ドキュメント作成の基本 仲田 尚央

あとがきの冒頭がこの本で伝えたいことを端的に表している。

良いドキュメントを描くために必要なのは、文章力より設計力だと思います。設計とはつまり、「あるべき情報があるべき場所にあり、そこに読み手が辿り着ける」ようにすることです。

p302

以下の流れで、設計していく。

  1. 読者を決める=テーマを決める
  2. テーマを分解する=全体の構成を考える
  3. アウトラインを作る=ドキュメントの構成を組む
  4. 見出し・パラグラフを決める
  5. わかりやすい文を書く

構造化文章に徹底的に乗っかるスタイル、と理解。本書で対象のユーザーマニュアル、要件定義書、提案書、報告書などでは、守るべき基本原則となる。

質の高いドキュメントの論拠として、ISO9241-11のユーザビリティの定義を引用する。つまり、知りたい内容に簡単にたどりつけ、効率よく理解でき、読み手の心情に配慮しているのが、良いドキュメント。

良いドキュメントの3つの要素(p19)

良いドキュメントの3つの要素(p19)

第7章ではChatGPTを使用し、本文の校正だけでなく、AIが学習済の基本的な全体のアウトラインをAIに提案させ全体構成を決めていく手法が紹介されている。AIの提案するアウトラインは目的にそぐわないか、そもそも構成がおかしいこともあるが、あくまで補助として使うことで、最初のテーマ決めや全体設計の産みコストを減らすことができる。こうした「壁打ち相手」としてのチャットAI利用はどんどんメジャーになっている。