操作
機能追加・改修 #613
完了docs: 条件付きテンプレート(API/状態遷移/バックアップ復旧/CI-CD)の要否判断と作成
開始日:
2026/07/29
期日:
進捗率:
0%
予定工数:
説明
- 1. User Story
開発チームとして、API・状態遷移・バックアップ復旧・CI/CDそれぞれについて、このプロジェクトに必要かどうかを判断し、必要なものは条件付きドキュメントとして残したい。なぜなら `docs/requirements/README.md` のルール上、不要なら不要と判断した理由を残す必要があるから。
- 2. Background
- 関連PRD: `docs/requirements/quantity-takeoff-concept.md`
- 関連要件: `docs/requirements/functional-requirements.md`、`docs/requirements/data-model.md`
- 関連設計書: `docs/requirements/README.md`「条件に応じて追加するもの」
- 現状の課題: `api-contracts.md`、`state-transitions.md`、`backup-and-recovery.md`、`ci-cd.md` のいずれも未着手
- 先行Issue/依存関係: なし
- 3. Scope
- Laravel APIを外部/フロントエンドが利用するため `api-contracts.md` の要否を判断する
- 図面改訂・見積版・単価マスター履歴など状態を持つ業務があるため `state-transitions.md` の要否を判断する
- 永続データ(案件・図面・見積)を保存するため `backup-and-recovery.md` の要否を判断する
- `ci-cd.md` の要否を判断する
- 必要と判断したものは作成し、不要と判断したものは理由を `docs/requirements/decisions/` に記録する
- 4. Out of Scope
- CI/CDパイプラインの実装
- バックアップの実運用構築
- 5. Acceptance Criteria
- [ ] 4つの条件付きドキュメントそれぞれについて、作成または「不要」の判断が記録されている
- [ ] 「不要」と判断したものは `docs/requirements/decisions/` に理由が残っている
- 6. Testing Requirements
- 追加/更新テスト: なし(ドキュメントのみ)
- 実行コマンド: なし
- 手動確認: data-model.md・functional-requirements.mdとの整合確認
- 7. Technical Notes
- 対象レイヤ: ドキュメントのみ
- 依存テーブル: なし
- 関連API/Job/View: なし
- 使用ライブラリ: なし
- Queue影響: なし
- 関連ブランチ戦略: 通常のfeatureブランチ
- 8. Docs to Update
- [x] `docs/progress-status.md`
- [x] `docs/requirements/README.md`
- [ ] `docs/requirements/api-contracts.md`(要否判断による)
- [ ] `docs/requirements/state-transitions.md`(要否判断による)
- [ ] `docs/requirements/backup-and-recovery.md`(要否判断による)
- [ ] `docs/requirements/ci-cd.md`(要否判断による)
- 9. Runtime Assumptions
- 実行環境: なし(ドキュメント作業)
- DB前提: なし
- Queue前提: なし
- 実装前に読むdocs: `functional-requirements.md`、`data-model.md`、`docs/requirements/README.md`
- 10. Done Definition
- [ ] Acceptance Criteriaを満たす
- [ ] 必要なdocsが更新されている
---
対応するGitHub Issue: https://github.com/iplusone/construction-estimate/issues/6
操作