h-1.flutter.4/README.md
joe ff0fa2f745 feat: 工程管理ドキュメント作成・README に活用ガイドライン追加
- docs/engineering_management.md (工程管理フレームワーク)
- docs/short_term_plan.md (2 週間単位のタスクリスト)
- docs/long_term_plan.md (3〜12 ヶ月ロードマップ)
- README.md (ドキュメント活用方法の明記)
2026-03-07 16:56:31 +09:00

84 lines
No EOL
5.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 販売アシスト 1 号「母艦お局様」プロジェクト概要
**開発コード**: CMO-01 (Commercial Management Office - Version 1)
**最終更新日**: 2026/03/07
---
## 📋 プロジェクトドキュメント
| ドキュメント | 内容 | パス | 活用シーン | 更新頻度 |
| --- | --- | --- | --- | --- |
| [要件定義書](./docs/requirements.md) | 機能要件・非機能要件・アーキテクチャ定義 | 新機能開発時の要件確認<br>チームメンバーへの仕様共有<br>承認プロセスでの根拠資料 | 変更時 |
| [工程管理ガイド](./docs/engineering_management.md) | **工程管理フレームワーク**(活用方法明記) | 📝 スプリント管理・ステークホルダー報告<br>リスク管理・承認フロー定義<br>新規参入者へのオンボーディング資料 | 各スプリント完了時<br>⬅️ **優先的に参照** |
| [短期計画Sprint](./docs/short_term_plan.md) | **2 週間単位のタスクリスト**CheckList | 📋 次の週の仕事割り当て<br>実捗確認・チェックオフ管理<br>スプリントレビュー資料準備 | 各スプリント開始時 |
| [長期計画Roadmap](./docs/long_term_plan.md) | **3〜12 ヶ月目標**・マイルストーンロードマップ | 🎯 ベータ→正式版リリース道筋<br>チーム成長・人材獲得計画<br>機能拡張優先順位決定資料 | マイルストーン完了時 |
| [プロジェクト計画書](./docs/project_plan.md) | 統合計画書(承認用) | ステークホルダーレビュー<br>M1-M3 マイルストーン記録<br>リリース条件確認 | 各ステークホルダーレビュー時 |
**📚 ドキュメント活用法**:
- **新規参入者**: README → requirements.md → short_term_plan.md の順に読み進めて「何を」「なぜ」やるか理解
- **スプリント開始**: short_term_plan.md の未着手タスクリストを確認→アサイン・実装開始
- **ステークホルダー報告**: project_plan.md + long_term_plan.md で達成状況を説明資料として作成
- **リスク管理**: 発生事項は engineering_management.md に記録→チーム会議で対応策共有
- **バージョンアップ**: MAJOR バージョン時 → requirements.md の移行ガイド確認
---
## 🎯 コアコンセプト
販売アシスト 1 号は **オフライン単体で見積・納品・請求・レジ業務まで完結できる販売アシスタント** であり、オプション機能として **オンライン接続時に母艦「お局様」とデータ同期・バックアップ・監視を行う二層構造** を目指しています。
### コンセプト比較表
| モード | 目的 | 主な特徴 |
| --- | --- | --- |
| オフライン・スタンドアロン | 端末単体で全業務を完結 | SQLite に全データ保存、印影以外は非暗号化、AI などによる再利用も想定 |
| オンライン(システムオプション) | 母艦と接続しデータ交換・監視 | SSH/クラウドトンネル経由で同期、APK 寿命チェックやバックアップを遠隔制御 |
母艦「お局様」はブリッジ/モニタリング/バックアップに専念し、実務機能は販売アシスト 1 号側に集約する方針です。TV BOX を母艦に据える運用や、単一端末で両役割を兼務するシナリオも想定しています。
---
## 📝 ドキュメント管理ポリシー
ドキュメントを更新するタイミングと方針:
| 更新トリガー | 対象ドキュメント | 頻度 |
| --- | --- | --- |
| 機能実装完了 | 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 マスタ管理画面が完成しました:
| 画面名 | ファイル名 | 主要機能 |
|--------|-------------|----------|
| 商品マスタ | `lib/screens/master/product_master_screen.dart` | 商品コード、名称、単価、在庫数の CRUD |
| 得意先マスタ | `lib/screens