X(Twitter) Zenn GitHub RSS 共有

ドキュメントライティング 1 はじめに

作成日時:2025-08-11
更新日時:2025-08-13

「建築業界では、大抵の悲劇はコミュニケーションの失敗が原因」
-ガワンデ,アトゥール. “アナタはなぜチェックリストを使わないのか”. 晋遊舎, 2011, P.82

目次

  1. はじめに
  2. 思想
  3. 結論を先に述べる
  4. コーディング原則を使用する
  5. 型を使用する
  6. 文書作成のルール
  7. 文法
  8. 参考情報

1 はじめに

本書はドキュメントライティングに関する情報を記載している。
主に日本のシステム開発の現場における情報連携や、AIに対するプロンプトなどを対象としている。
小説やコラムなどの類は対象としていない。

1.1 なぜドキュメントライティングの技術が求められるか

情報は伝わらなければ意味が無い。
伝わっても間違って捉えられたら意味が無い。

特にシステム開発の現場において、情報が明確に伝わらないことは致命的である。
発生した曖昧性は雪だるま式に膨れ上がり、いずれは現場を破綻させる。

故にドキュメントライティングの技術を習得し、情報を明確に伝える能力が必要である。

1.2. AI時代に向けて

AIを効果的に活用するにはどうすればいいか。
適切なコンテキストやプロンプトを構築し、AIに渡すことが重要である。
これを可能にするには何が必要か。
ドキュメントライティングの技術である。

質の低いプロンプトを渡せば、意図しない回答を出す。
ハルシネーションの発生可能性も上がる。
コンテキストを渡さなければ、背景を無視した回答を出す。

AIの性能を引き出すには、情報を明確に伝える能力が必要である。

1.3 常に求められる普遍的なスキル

ドキュメントライティングの技術は、常に求められる普遍的なスキルである。
今後、技術がどんなに進歩したとしても求められる。

AIが発展したら、AIに対して適切なプロンプトを投げるスキルが必要である。
また。AIが発展しても人間に情報連携をする作業は無くならない。

次へ