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

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

読み方ガイド

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

前提知識

  • Markdown の基本
  • Git/GitHub の基本(Issue/PR)

所要時間(目安)

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

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

目次

付録