# APIドキュメント同期チェックリスト

このチェックは「実装変更があるタスク」を完了扱いにする前に必ず実施する。

## 1. 変更検知

- 実装差分ファイルを列挙したか。
- 変更対象エンドポイント（追加/変更/削除）を特定したか。

## 2. 一覧ドキュメント（index）

- 新規エンドポイントを一覧に追加したか。
- 削除・非推奨エンドポイントを一覧へ反映したか。
- 認証/共通エラー形式の変更を反映したか。

## 3. 詳細ドキュメント（endpoint）

- 影響する全エンドポイントの詳細ファイルを更新したか。
- 以下の項目が実装と一致しているか。
  - METHOD / PATH
  - 認証要件
  - パス/クエリ/ボディ
  - 成功レスポンスとエラーレスポンス
  - 主要なステータスコード

## 4. 推測排除

- 実装で確認できない内容を断定記述していないか。
- 不明点を `TODO(要実装確認)` で明示したか。

## 5. 完了ゲート

- API実装差分があるのに、APIドキュメント差分がゼロではないか。
- ドキュメントリンク切れがないか。
- 変更報告に更新ファイル一覧を含めたか。

## 6. 任意の自動チェック

```bash
python3 scripts/playbooks/api-spec-sync/check_api_docs_sync.py --docs-root docs/api
```

必要に応じて `--code-path` を追加し、実装ファイルの探索範囲をプロジェクトに合わせて調整する。
