第1章：実務ドキュメントの全体像（目的別・成果物別マップ）

この章で学ぶこと

• README/手順書/Runbook/ADR/障害報告の使い分け基準を理解する
• 目的（理解/実行/判断）に応じて成果物を選ぶ
• 成果物を「マップ」として整理する

この章の成果物（または判断基準）

• 成果物マップ（目的×成果物）
• 付録テンプレへの導線（テンプレ集）

本文

実務で起きがちな失敗は、成果物が混在すること（例: READMEに運用手順が埋もれる）。まず「何のための文書か」を固定する。

使い分け（最小）

• README: 入口。何があり、どう動かすか
• 手順書: 1回の作業を再現する
• Runbook: 異常時を含む運用を回す
• ADR: 判断の背景と選択肢を残す
• 障害報告/ポストモーテム: 事象と学びを残す

この章のゴールは「どの成果物を書くべきか」を説明できる状態にすること。

具体例（悪い例→良い例）

悪い例

README に以下を全部書く
- デプロイ手順
- 障害時の対応
- 意思決定の背景
（どこに何があるか分からない）

良い例

README は入口に絞る
- Quick Start
- 依存/権限
- 運用導線（Runbook へのリンク）
デプロイは手順書、障害対応はRunbook/障害報告、判断はADRに分離

チェックリスト

• 目的（理解/実行/判断）が明確
• 成果物が混ざっていない
• 入口（README）から導線がある

まとめ

• 目的（理解/実行/判断）から成果物を選び、1つの文書に混在させない
• README を入口にし、手順書/Runbook/ADR/障害報告へ導線を用意する

次章への接続

• 次章: 第2章