Documentation Workflow
基本ルール
実装変更と設計変更を同じ Pull Request で扱います。
| 変更 | 必須更新 |
|---|---|
| DB migration | DBML、DB設計ページ |
| API endpoint | OpenAPI、API設計ページ |
| 画面追加 | 画面仕様、Route Map |
| 権限変更 | DB設計、アーキテクチャ |
PRチェック観点
- 実装と設計が同期している。
- 仕様の正本が明確である。
- 画面URL、データソース、権限が書かれている。
- MkDocs がビルドできる。
ローカル確認
mkdocs build --strict
mkdocs serve