操作
機能追加・改修 #612
完了docs: deploy/runbook/release ドキュメントを監視・復旧・ロールバックまで具体化する
開始日:
2026/07/29
期日:
進捗率:
0%
予定工数:
説明
- 1. User Story
運用担当者として、配備・障害対応・リリース手順を具体的に把握したい。なぜなら本番運用時に監視・復旧・ロールバックを迷わず実行できるようにしたいから。
- 2. Background
- 関連PRD: なし
- 関連要件: `docs/requirements/non-functional-requirements.md`(Issue #TBD)
- 関連設計書: `docs/vps-deploy.md`、`docs/operations-runbook.md`、`docs/release-checklist.md`
- 現状の課題: 各docsの雛形はあるが、監視・復旧・ロールバックの具体的な手順が未整備
- 先行Issue/依存関係: 非機能要件Issue(可用性・復旧項目)を先に確定させることが望ましい
- 3. Scope
- `docs/vps-deploy.md` に配備手順を具体化する
- `docs/operations-runbook.md` に監視・障害対応・復旧手順を追記する
- `docs/release-checklist.md` にロールバック手順を追記する
- 4. Out of Scope
- 実際の監視ツール導入・本番環境構築
- CI/CDパイプラインの実装(別Issueで扱う)
- 5. Acceptance Criteria
- [ ] `vps-deploy.md`、`operations-runbook.md`、`release-checklist.md` の未記入箇所が解消されている
- [ ] ロールバック手順が明記されている
- 6. Testing Requirements
- 追加/更新テスト: なし(ドキュメントのみ)
- 実行コマンド: なし
- 手動確認: 手順に沿って実際に配備できるか、次回配備時に検証する
- 7. Technical Notes
- 対象レイヤ: ドキュメント/インフラ運用
- 依存テーブル: なし
- 関連API/Job/View: なし
- 使用ライブラリ: なし
- Queue影響: なし
- 関連ブランチ戦略: 通常のfeatureブランチ
- 8. Docs to Update
- [x] `docs/progress-status.md`
- [x] `docs/vps-deploy.md`
- [x] `docs/operations-runbook.md`
- [x] `docs/release-checklist.md`
- 9. Runtime Assumptions
- 実行環境: VPS本番環境(想定)
- DB前提: MySQL 8.4
- Queue前提: 未定
- 実装前に読むdocs: `docs/requirements/non-functional-requirements.md`
- 10. Done Definition
- [ ] Acceptance Criteriaを満たす
- [ ] 必要なdocsが更新されている
---
対応するGitHub Issue: https://github.com/iplusone/construction-estimate/issues/5
操作