ドキュメンテーション
どきゅめんてーしょん
Documentation
一言でいうと
コードや製品に関する情報を文書化して、後の人や関係者が理解できる状態に保つ取り組みのこと。
詳しい意味
ドキュメンテーション（ドキュメント整備）は、コード・APIの使い方・設計判断・運用手順・障害対応マニュアルなどを文書化し、書いた本人がいなくても他の人が理解・利用できる状態に保つ取り組みです。良いドキュメントは「Why（なぜそうしたか）」を残すのが特徴で、コード自体からは読み取れない判断の背景が長期的な資産になります。種類として「README」「API仕様書」「ADR（Architecture Decision Record）」「Runbook（運用手順書）」「Onboarding doc」などがあります。コードの近くに置く（リポジトリ内）と腐りにくい、というのが定石です。
何に使うか
新しいメンバーがプロジェクトに参加するとき。本番障害時に手順を即時参照したいとき。半年後の自分が判断の理由を思い出したいとき。
どんな時に出るか
「ドキュメント書こう」「ドキュメントが古い」「ADRに残しておこう」といった場面で登場します。
具体例
- 新人オンボーディング用のドキュメントを整備したら、自走できるまでの期間が半分になった。
- 重要な設計判断は ADR としてリポジトリに残し、後から「なぜこうした？」が辿れるようにしている。
別名・略称
documentation(どきゅめんてーしょん)ドキュメント(どきゅめんと)ADR(えーでぃーあーる)Runbook(らんぶっく)
関連語
初心者向けメモ
料理屋の「レシピノート」のようなものです。料理長が書いたレシピがあれば、新しい板前さんも同じ味を出せる。書いた本人がいなくなっても店が回り続ける。コードでも全く同じ理由でドキュメントが要ります。