Appearance
アーキテクチャ
docs/architecture/ は、実装全体に影響する構造、責務分担、設計原則を置くカテゴリです。個別機能の仕様ではなく、複数機能に共通する考え方や実装の骨格を扱います。
このカテゴリに置くもの
- レイヤー構成、ディレクトリ構成、依存方向などの全体方針
- DI、bootstrap、ショートコードライフサイクルなど横断的な仕組み
- モジュール境界やアダプタ層など、複数機能に影響する設計判断
- 本番デプロイに関わるアーキテクチャ上の制約
個別の画面、API、ショートコード、バッチ仕様は 設計書 配下に置きます。
正本ドキュメント
| 目的 | 正本 |
|---|---|
| 全体像 | プロジェクトアーキテクチャ |
| ディレクトリと責務 | ディレクトリ構成 / レイヤー責務 |
| 設計原則 | 設計原則 |
| MVC / DIP | MVC と DIP |
| bootstrap / DI | bootstrap と DI |
補助資料・履歴資料の扱い
検討メモや関連ファイルの補足は、正本へのリンクを冒頭に置いたうえで追加します。現在の実装ルールとして有効な内容は、補助資料に残さず正本へ反映してください。