Design
Context¶
現在、docs/index.md のドメインモデルテーブルには「概念」「定義」「例」の3列があるが、コード内で使用する英語用語が明示されていない。開発者は src/ 内のコードを参照して英語名を推測する必要がある。
本変更は単純なドキュメント更新であり、コード変更は最小限(または不要)。
Goals / Non-Goals¶
Goals:
- docs/index.md のドメインモデルテーブルに「英語用語」列を追加
- コード内の用語使用状況を確認し、ドキュメントとの整合性を検証
- 不一致があれば修正方針を決定
Non-Goals:
- コード全体のリファクタリング
- 新機能の追加
- 既存機能の動作変更
Decisions¶
1. テーブル形式の変更¶
| 決定 | 理由 |
|---|---|
| 「英語用語」列を「例」列の後に追加 | 概念→定義→例→英語用語の順が自然な読み順 |
| コード内での使用形式も併記 | groupId, memberId 等の実際のコード表現を明示 |
2. 用語マッピング¶
| 日本語概念 | 英語用語 | コード表現 |
|---|---|---|
| 参加者レポート | Attendance Report | — |
| 参加記録 | Attendance Record | — |
| 会議グループ | Meeting Group | group, groupId |
| メンバー | Member | member, memberId |
| 会議 | Session | session, sessionId |
| 参加 | Attendance | attendance |
3. 検証アプローチ¶
- src/services/ 内の主要ファイルで用語使用を grep 確認
- 不一致発見時はコード修正ではなくドキュメント側を実態に合わせる
Risks / Trade-offs¶
| リスク | 軽減策 |
|---|---|
| テーブルが横に広がりすぎる | 必要最小限の情報に留める |
| コード内に別表現が混在している可能性 | 主要な表現のみ記載、マイナーな差異は許容 |