docs: README に工程管理ドキュメントの活用ポリシー追加
- 📋 ドキュメント管理テーブル(更新トリガー・頻度) - 🔄 semver ベースのバージョン管理方針明記 - ✅ 承認フローの定義(Plan/Review/Approve/Register/Update)
This commit is contained in:
parent
8ea10dad79
commit
735687cb39
1 changed files with 43 additions and 10 deletions
53
README.md
53
README.md
|
|
@ -7,10 +7,10 @@
|
||||||
|
|
||||||
## 📋 プロジェクトドキュメント
|
## 📋 プロジェクトドキュメント
|
||||||
|
|
||||||
|ドキュメント|内容|パス|
|
| ドキュメント | 内容 | パス | 活用シーン | 更新頻度 |
|
||||||
|---|---|---||
|
| --- | --- | --- | --- | --- |
|
||||||
|要件定義書|[docs/requirements.md](./docs/requirements.md)|全体機能・スケジュール|
|
| [要件定義書](./docs/requirements.md) | 機能要件・非機能要件・アーキテクチャ定義 | 新機能開発時の要件確認<br>チームメンバーへの仕様共有<br>承認プロセスでの根拠資料 | 変更時 |
|
||||||
|プロジェクト計画|[docs/project_plan.md](./docs/project_plan.md)|チーム構成・マイルストーン|
|
| [プロジェクト計画書](./docs/project_plan.md) | 短期長期計画・マイルストーン・リスク管理 | スプリントプランニング<br>レビューサイクルの計画<br>ステークホルダー報告 | 各フェーズ完了時 |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -29,6 +29,41 @@
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## 📝 ドキュメント管理ポリシー
|
||||||
|
|
||||||
|
ドキュメントを更新するタイミングと方針:
|
||||||
|
|
||||||
|
| 更新トリガー | 対象ドキュメント | 頻度 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| 機能実装完了 | README.md, project_plan.md | 直後 |
|
||||||
|
| 要件追加/修正 | requirements.md | 即座に |
|
||||||
|
| マイルストーン完了 | project_plan.md | フェーズ完了時 |
|
||||||
|
| リスク発生・対応策決定 | project_plan.md (リスク管理節) | 発生日 |
|
||||||
|
| アーキテクチャ変更 | README.md, requirements.md | 計画立案後 |
|
||||||
|
|
||||||
|
### 🔄 バージョン管理方針 (semver)
|
||||||
|
|
||||||
|
- `MAJOR`: バックワーズ互換性の破壊(DB スキーマ変更、API ラストメソッド等)
|
||||||
|
- `MINOR`: 新機能追加、可逆的変更、ドキュメント改善
|
||||||
|
- `PATCH`: バグ修正、パフォーマンス向上、セキュリティパッチ
|
||||||
|
|
||||||
|
**ルール**:
|
||||||
|
- MAJOR バージョンアップ時は `requirements.md` で移行ガイドを記載する
|
||||||
|
- ドキュメントは Git commit と同時に README に反映させる(例:`git commit -m "feat: XXX"` → README 更新)
|
||||||
|
|
||||||
|
### ✅ 承認フロー
|
||||||
|
|
||||||
|
1. ドキュメント作成・修正 (Plan Phase)
|
||||||
|
2. チームレビュー(必要に応じて)
|
||||||
|
3. 要件定義書 (`requirements.md`) の承認(CTO/管理母艦)
|
||||||
|
4. プロジェクト計画書 (`project_plan.md`) のマイルストーン登録
|
||||||
|
5. README.md にドキュメントリンク追加
|
||||||
|
|
||||||
|
**最終更新**: 2026/03/07
|
||||||
|
**バージョン**: 1.0 (Initial Release)
|
||||||
|
|
||||||
|
(中略 - 実装完了マスタ管理画面から開始)
|
||||||
|
|
||||||
## 実装完了マスタ管理画面
|
## 実装完了マスタ管理画面
|
||||||
|
|
||||||
Material Design テンプレートを使用した CRUD 機能を実装した以下の 5 マスタ管理画面が完成しました:
|
Material Design テンプレートを使用した CRUD 機能を実装した以下の 5 マスタ管理画面が完成しました:
|
||||||
|
|
@ -191,8 +226,7 @@ Material Design テンプレートを使用した CRUD 機能を実装した以
|
||||||
├── scripts/build_with_expiry.sh … dart-define 付きビルドスクリプト
|
├── scripts/build_with_expiry.sh … dart-define 付きビルドスクリプト
|
||||||
├── android/, ios/, macos/, windows/, linux/ … 各プラットフォームテンプレート
|
├── android/, ios/, macos/, windows/, linux/ … 各プラットフォームテンプレート
|
||||||
├── assets/ … 画像・リソース
|
├── assets/ … 画像・リソース
|
||||||
├── test/ … テストコード
|
|
||||||
└── 目標.md / 目的.md … 設計メモ
|
|
||||||
```
|
```
|
||||||
|
|
||||||
※ フルツリーが必要になった場合は `tree` や `list_dir` の出力を README 末尾に追加して更新していきます。
|
※ フルツリーが必要になった場合は `tree` や `list_dir` の出力を README 末尾に追加して更新していきます。
|
||||||
|
|
@ -244,15 +278,15 @@ Material Design テンプレートを使用した CRUD 機能を実装した以
|
||||||
dart run bin/mothership_server.dart
|
dart run bin/mothership_server.dart
|
||||||
```
|
```
|
||||||
- 環境変数 `MOTHERSHIP_HOST`, `MOTHERSHIP_PORT`, `MOTHERSHIP_API_KEY`, `MOTHERSHIP_DATA_DIR` で上書き可能
|
- 環境変数 `MOTHERSHIP_HOST`, `MOTHERSHIP_PORT`, `MOTHERSHIP_API_KEY`, `MOTHERSHIP_DATA_DIR` で上書き可能
|
||||||
- 既定値: `0.0.0.0:8787`, API キー `TEST_MOTHERSHIP_KEY`, 保存先 `data/mothership`
|
- 既定値:`0.0.0.0:8787`, API キー `TEST_MOTHERSHIP_KEY`, 保存先 `data/mothership`
|
||||||
- `data/mothership/status.json` に各クライアントの心拍/ハッシュを保存
|
- `data/mothership/status.json` に各クライアントの心拍/ハッシュを保存
|
||||||
3. ブラウザで `http://<host>:<port>/` を開くとステータス一覧を閲覧できます(CUI 常駐で OK)
|
3. ブラウザで `http://<host>:<port>/` を開くとステータス一覧を閲覧できます(CUI 常駐で OK)
|
||||||
|
|
||||||
### クライアント(販売アシスト 1 号)からの接続設定
|
### クライアント(販売アシスト 1 号)からの接続設定
|
||||||
|
|
||||||
1. アプリの `S1:設定` → 「外部同期(母艦システム『お局様』連携)」で以下を入力
|
1. アプリの `S1:設定` → 「外部同期(母艦システム『お局様』連携)」で以下を入力
|
||||||
- ホストドメイン: `http://192.168.0.10:8787` のようにプロトコル付きで指定
|
- ホストドメイン:`http://192.168.0.10:8787` のようにプロトコル付きで指定
|
||||||
- パスワード: サーバ側 API キー(例: `TEST_MOTHERSHIP_KEY`)
|
- パスワード:サーバ側 API キー(例:`TEST_MOTHERSHIP_KEY`)
|
||||||
2. 保存するとアプリ起動時に `POST /sync/heartbeat` が自動送信され、寿命残時間が母艦に表示されます。
|
2. 保存するとアプリ起動時に `POST /sync/heartbeat` が自動送信され、寿命残時間が母艦に表示されます。
|
||||||
3. 同じ設定でチャット送受信・ハッシュ送信が有効になります(下記参照)。
|
3. 同じ設定でチャット送受信・ハッシュ送信が有効になります(下記参照)。
|
||||||
|
|
||||||
|
|
@ -268,4 +302,3 @@ Material Design テンプレートを使用した CRUD 機能を実装した以
|
||||||
|
|
||||||
- README は **機能追加・アーキテクチャ変更・モジュール構成の見直し時に必ず更新** します。
|
- README は **機能追加・アーキテクチャ変更・モジュール構成の見直し時に必ず更新** します。
|
||||||
- 変更履歴とファイルツリーは必要に応じて追記し、最新状態を反映させます。
|
- 変更履歴とファイルツリーは必要に応じて追記し、最新状態を反映させます。
|
||||||
- 設計検討中の内容(母艦 Web UI、チャット、モジュール化など)は本 README の「将来像」節で随時アップデートします。
|
|
||||||
Loading…
Reference in a new issue