プロジェクト資料
競馬向け馬体診断アプリの運用インフラ（FB 受信・再学習・CI/CD・配布）を検証するプロジェクトの公式資料です。 インフラ案件で一般的な「計画 → 設計 → 手順 → 連携 → 参照 → 記録」の順で読めるよう整理しています。
1. ドキュメント体系（標準 6 層 + 2 補助）
他プロジェクトでもよく使われる層に対応しています。上から順に「何を・なぜ」→「どう動く」→「どうやる」→「誰とつなぐ」→「調べる」→「経緯」の流れです。
flowchart TB L1["① 計画
What / When"] L2["② 設計
How it works"] L3["③ 構築・運用
How to do"] L4["④ 外部連携
Interfaces"] L5["⑤ 参照
Glossary / Schema"] L6["⑥ 記録
WBS / Log"] L7["補助: ナレッジ
Why / Troubleshoot"] L1 --> L2 --> L3 L2 --> L4 L2 --> L5 L1 --> L6 L3 --> L7
| 層 | 文書 | 典型的な内容 | いつ読むか |
|---|---|---|---|
| ① 計画 | plans.html | スコープ、スケジュール、本番導入・運用方針、検証計画 | プロジェクト参画時・マイルストーン確認時 |
| ② 設計 | design.html | 構成、API、セキュリティ、データフロー、シーケンス | 実装・レビュー前。変更の影響範囲を把握するとき |
| ③ 構築・運用 | runbook.html | 初回構築、日常運用、配布、障害対応、PC 移設 | 手を動かすとき（最も参照頻度が高い） |
| ④ 外部連携 | integration.html | 山梨大 Worker との境界、データ取得方式、GHA dispatch | 連携設計・会議・結合試験の前 |
| ⑤ 参照 | reference.html | 用語集、DB スキーマ、DDL | 用語・テーブル定義を確認するとき |
| ⑥ 記録 | records.html | WBS、開発ログ、完了レビュー | 「いつ何をしたか」「いまどこまで」の確認 |
| 補助 | knowledge.html | FAQ・エラー対処・設計の「なぜ」（K-01〜K-31） | 詰まったとき。設計の背景を深く知りたいとき |
2. 担当者別 — 最初に読むページ
3. リポジトリ構成とシークレット
| ディレクトリ | 役割 | 秘密情報（.env 等） |
|---|---|---|
server/ |
FB 受信 API、PostgreSQL、Tunnel | server/.env — TUNNEL_TOKEN、POSTGRES_*、FEEDBACK_API_KEY |
worker/ |
再学習スタブ・GHA dispatch | worker/.env — GITHUB_TOKEN、GITHUB_REPOSITORY |
app/ |
Flutter スタブ Android | ビルド時 --dart-define=FEEDBACK_API_KEY=... |
scripts/ |
疎通・APK 配布・月次パイプライン | なし（上記 .env を参照） |
詳細: K-27 / K-02。手順: Runbook §1。
4. 現在の進捗
Phase1（Android インフラ）: MS-3 達成（2026-06-11）。SEC-01 実機検証済み（2026-06-15）。
Phase2（本番移行）: パターン A（DB + Storage）でバッチ構築、役場 PC 移設（Runbook §5）。
経緯: 記録 §2 開発ログ。
Phase2（本番移行）: パターン A（DB + Storage）でバッチ構築、役場 PC 移設（Runbook §5）。
経緯: 記録 §2 開発ログ。
| マイルストーン | 内容 | 状態 |
|---|---|---|
| MS-1 | Tunnel 経由 FB 受信 | 達成 |
| MS-2 | GHA APK ビルド・配布 | 達成 |
| MS-3 | ① Android 向け検証 完了 | 達成 |
| WBS 3.1.1 | 役場 PC への移設 | 進行中 |