BOOK-PROPOSAL.md

BOOK PROPOSAL

目的

未経験〜初級が、実務で求められるドキュメント成果物（README/手順書/Runbook/ADR/障害報告・ポストモーテム）を“作れる”状態にする。

対象読者

• ソフトウェア/インフラ問わず、実務経験が浅いエンジニア
• OJTや研修でドキュメントの型を揃えたいチーム
• レビュー観点や責任分界を明確化したいリード層

前提知識

• Markdown の基本
• Git/GitHub の基本（Issue/PR）

到達目標

• 本書の章立てに沿って、必要な成果物・判断基準をテンプレ/チェックリストとして再利用できる
• チーム内の説明コスト（口頭補足/属人化）を下げ、レビュー観点を共有できる

非スコープ

• 特定製品の詳細な設計・実装手順（製品依存部分）
• 図解ツールの高度な使い方（本書は最小セットの考え方を扱う）

章立て（確定）

• 第1章: 実務ドキュメントの全体像（目的別・成果物別マップ）（狙い: 実務ドキュメントの全体像（目的別・成果物別マップ）を実務判断/成果物に落とす）
• 第2章: 読者と目的から逆算する（Who/Why/What）（狙い: 読者と目的から逆算する（Who/Why/What）を実務判断/成果物に落とす）
• 第3章: 情報設計（前提/用語/粒度/スコープ境界）（狙い: 情報設計（前提/用語/粒度/スコープ境界）を実務判断/成果物に落とす）
• 第4章: 技術文体（曖昧さ排除・手順の書き方・例外系）（狙い: 技術文体（曖昧さ排除・手順の書き方・例外系）を実務判断/成果物に落とす）
• 第5章: 図解（構成図/フロー/シーケンスの最小セット）（狙い: 図解（構成図/フロー/シーケンスの最小セット）を実務判断/成果物に落とす）
• 第6章: 手順書（実行前提/検証/ロールバック/リスク）（狙い: 手順書（実行前提/検証/ロールバック/リスク）を実務判断/成果物に落とす）
• 第7章: Runbook（平常時/異常時/エスカレーション）（狙い: Runbook（平常時/異常時/エスカレーション）を実務判断/成果物に落とす）
• 第8章: ADR（意思決定記録：背景→選択肢→決定→影響）（狙い: ADR（意思決定記録：背景→選択肢→決定→影響）を実務判断/成果物に落とす）
• 第9章: 障害報告・ポストモーテム（タイムライン/真因/再発防止）（狙い: 障害報告・ポストモーテム（タイムライン/真因/再発防止）を実務判断/成果物に落とす）
• 第10章: Docs-as-Code運用（レビュー/版管理/CI/公開）（狙い: Docs-as-Code運用（レビュー/版管理/CI/公開）を実務判断/成果物に落とす）
• 第11章: ドキュメント品質の守り方（陳腐化対策/Owner/KPI）（狙い: ドキュメント品質の守り方（陳腐化対策/Owner/KPI）を実務判断/成果物に落とす）

付録

• templates: テンプレ集
• checklists: チェックリスト集
• references: 参考文献
• glossary: 用語集

執筆フォーマット（各章の固定セクション）

• この章で学ぶこと
• 成果物（または判断基準）
• 具体例（悪い例→良い例）
• チェックリスト
• まとめ
• 次章への接続