エンジニアリングドキュメント実践ガイド:README・手順書・Runbook・ADR・ポストモーテム
未経験〜初級が、実務で求められるドキュメント成果物(README/手順書/Runbook/ADR/障害報告・ポストモーテム)を作成できる状態にする。
読み方ガイド
- まず目次を眺め、いま必要な成果物/判断がどこにあるかを特定する
- 付録のテンプレ/チェックリストを先に読み、本文で意図と落とし穴を補完する
- 章末のチェックリストをレビュー観点として運用に取り込む
前提知識
- Markdown の基本
- Git/GitHub の基本(Issue/PR)
所要時間(目安)
- 全章を通読: 3〜5時間(テンプレを自分の題材で埋める場合は +2〜4時間)
- 必要な成果物だけ読む: 30〜60分/章
注記: 既存システムの規模、関係者数、既存ドキュメントの有無により大きく変動する。
目次
- 第1章: 実務ドキュメントの全体像(目的別・成果物別マップ)
- 第2章: 読者と目的から逆算する(Who/Why/What)
- 第3章: 情報設計(前提/用語/粒度/スコープ境界)
- 第4章: 技術文体(曖昧さ排除・手順の書き方・例外系)
- 第5章: 図解(構成図/フロー/シーケンスの最小セット)
- 第6章: 手順書(実行前提/検証/ロールバック/リスク)
- 第7章: Runbook(平常時/異常時/エスカレーション)
- 第8章: ADR(意思決定記録:背景→選択肢→決定→影響)
- 第9章: 障害報告・ポストモーテム(タイムライン/真因/再発防止)
- 第10章: Docs-as-Code運用(レビュー/版管理/CI/公開)
- 第11章: ドキュメント品質の守り方(陳腐化対策/Owner/KPI)