Docs as Code
目的
DB、API、画面、運用の設計情報をコードと同じ粒度でレビューし、変更履歴を追える状態にします。
推奨フロー
flowchart LR
Change[実装変更] --> Spec[設計ファイル更新]
Spec --> Review[Pull Request]
Review --> Merge[main merge]
Merge --> Publish[GitHub Pages公開]
更新ルール
| 変更内容 | 更新する場所 |
|---|---|
| Supabase migration追加 | schema/schema.dbml, docs/db/ |
| FastAPI endpoint追加 | openapi/openapi.json, docs/api/ |
| Next.js route追加 | docs/screens/, docs/flows/routes.md |
| UI component追加 | Storybook、または docs/screens/ |
| 権限・RLS変更 | docs/db/, docs/architecture/ |
完了条件
- 実装PRに設計差分が含まれている。
- 仕様の一次情報がどこにあるか明記されている。
- MkDocs のローカルプレビューでリンク切れがない。