jamjam Specification Documents
本ディレクトリは AI→AI パイプライン用の仕様書を格納する。 すべてのドキュメントは実装の唯一の正とする。
ドキュメント構成
| ファイル | 説明 |
|---|---|
| architecture.md | 技術構成（最重要） |
| ui-ux-guideline.md | UI/UXガイドライン |
| adr/ | 設計判断記録（ADR） |
| api/ | API境界定義 |
| behavior/ | 振る舞い定義（BDD/Gherkin） |
ADR（設計判断記録）
| ADR | 決定内容 |
|---|---|
| ADR-001 | Rust採用 |
| ADR-002 | カスタムUDPプロトコル採用 |
| ADR-003 | 音声コーデック選択（複数対応） |
| ADR-004 | GUIフレームワーク選択（Tauri / Flutter） |
| ADR-005 | 音声処理を行わない方針 |
| ADR-006 | FEC（前方誤り訂正）採用 |
| ADR-007 | i18nライブラリ選定 |
| ADR-008 | ゼロレイテンシーモード |
| ADR-009 | Tauriビルドコマンド戦略 |
| ADR-010 | E2Eテストインフラストラクチャ |
API仕様
| API | 説明 |
|---|---|
| audio_engine.md | オーディオエンジンAPI |
| network.md | ネットワークAPI |
| signaling.md | シグナリングAPI |
| i18n.md | 国際化API |
BDD仕様
| Feature | 説明 |
|---|---|
| connection.feature | セッション接続 |
| audio-quality.feature | 音声品質 |
| latency.feature | 遅延管理 |
| i18n.feature | 国際化 |
更新ルール
- 実装が仕様に影響を与える変更を行った場合、同一コミットで仕様書も更新する
- ADR は追加のみ（既存 ADR の変更は原則禁止、変更が必要な場合は新規 ADR を作成）
- API 仕様は実装と常に同期を維持する
- BDD 仕様はテストコードと対応させる
開発者向けドキュメント
開発者向けの解説資料（ガイド、チュートリアル等）は Docs を参照。
docs-site/ の内容は仕様ではない。実装の正は常に本ディレクトリ（docs-spec/）である。