- URL: ソフトウェアを作って、ドキュメントを書かせる：LLMによる技術ドキュメンテーションの自動化
- 著者: おんがえし (tuto0621)
- 公開日: 2026-05-12
いつ読むか？
- ソフトウェア開発後にドキュメントをどう書くか迷ったとき
- LLM向けプロンプトの構造を整理したいとき
- 「Google Technical Writing」の原則をプロンプトに組み込む際の参考として
読書メモ
ソースコード・コミットログ・会話履歴からLLMに技術ドキュメントを生成させるワークフローの紹介。
プロンプトの型として洗練された4見出し構造が参考になる：
- Role — LLMに担わせる役割
- Constraints — AIスロップ（感情的表現・冗長な前置き）の排除ルール
- Output Structure — 成果物の形式定義
- Instruction — 具体的な指示
Google Technical Writing の原則（能動態・短文・箇条書き活用）をConstraintsに組み込むことで品質を担保できる。ドキュメントはコードと並ぶ成果物であり、設計の知見を独立した知識として残す手段になる。