// ドキュメント > 開発

開発ドキュメント

開発現場で必要なドキュメント種別ごとに「何を定義すべきか」を整理（全 9 カテゴリ・14 記事）

Categories
📄
README
プロジェクト概要・インストール・使い方を定義する
1記事 →
🏛️
ADR
アーキテクチャ決定の背景・選択肢・結果を記録する
1記事 →
📋
Runbook
運用手順・障害対応・ヘルスチェックを定義する
1記事 →
📝
CHANGELOG
バージョン・変更カテゴリ・Keep a Changelog 形式
1記事 →
🔌
API 仕様
エンドポイント・認証・スキーマ・エラー定義を書く
1記事 →
💬
コードコメント
「なぜ」を書く原則・docstring 形式・カバレッジ計測
1記事 →
🚀
オンボーディング
環境構築から初タスクまで・Python 環境診断スクリプト
1記事 →
🔍
ポストモーテム
タイムライン・根本原因・再発防止策の定義方法
1記事 →
⚠️
アンチパターン
SQL・コーディングの代表的なアンチパターンを体系的に解説
6記事 →