エンジニアリングドキュメント実践ガイド：README・手順書・Runbook・ADR・ポストモーテム

エンジニアリングドキュメント実践ガイド：README・手順書・Runbook・ADR・ポストモーテム

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

想定読者

  • README/手順書/Runbook/ADR/ポストモーテムを体系的に整えたい初級〜中級エンジニア
  • レビュー観点を揃えたいテックリード/EM
  • Docs-as-Code を導入したい開発チーム

学習成果

  • Who/Why/What を短文で定義できる
  • 成果物ごとに必要な情報粒度と例外系を判断できる
  • 図解テンプレと文書テンプレを再利用できる

読み方ガイド

  • まず第2章で読者と目的を固定し、いま必要な成果物/判断がどこにあるかを特定する
  • 図解の入口は第5章、テンプレの入口は付録のテンプレ集を使う
  • 付録のテンプレ/チェックリストを先に読み、本文で意図と落とし穴を補完する
  • 章末のチェックリストをレビュー観点として運用に取り込む

前提知識

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

すぐ開く先

所要時間（目安）

  • 全章を通読: 3〜5時間（テンプレを自分の題材で埋める場合は +2〜4時間）
  • 必要な成果物だけ読む: 30〜60分/章

注記: 既存システムの規模、関係者数、既存ドキュメントの有無により大きく変動する。

目次

付録

利用と更新情報

Edit this page on GitHub