プロジェクト構造設計書

プロジェクトの「Where（どこに何があるか）」を定義するプロジェクト構造設計書を作成します

対象製品：Acsim Desktop

このページは2026年10月23日時点の内容です。ほかの設計書フォーマットは標準カタログの一覧で確認できます。

作成するエージェント

この設計書は、次のエージェントが作成します。

技術仕様書作成

保存先

「技術仕様書」の 04_プロダクト フォルダに保存されます。ファイル名の先頭には、フォルダ内で読む順に並ぶよう 30_ が付きます。

構成

Acsim Desktop の設計書テンプレートの章立てと記載項目です。設計書はこの構成に沿って作成されます。

プロジェクト構造設計書 (structure.md)

このドキュメントは、プロジェクトの「Where（どこに何があるか）」を定義します。

1. ディレクトリ構成

1.1 全体構造

project-root/
├── src/                    # ソースコード
│   ├── [modules]/          # 機能モジュール
│   └── shared/             # 共有コード
├── tests/                  # テストコード
├── docs/                   # ドキュメント
└── config/                 # 設定ファイル

1.2 各ディレクトリの役割

ディレクトリ	役割	配置するもの
`src/`	[ユーザー指定の構造に従う]	[配置するもの]
`tests/`	[ユーザー指定のテスト構造に従う]	[配置するもの]

2. 命名規則

2.1 ファイルとディレクトリ

カテゴリ	規則	例
ディレクトリ	kebab-case	`user-management/`
主要クラス/コンポーネント	[規約に従う]	[例]

2.2 コード識別子

カテゴリ	規則	例
クラス/型	PascalCase	`UserService`
関数	camelCase	`getUserById`
定数	UPPER_SNAKE_CASE	`MAX_RETRY_COUNT`

3. レイヤー構造と依存関係

3.1 依存方向のルール

From → To	許可	備考
Presentation → Application	✅
Application → Domain	✅
Domain → 他レイヤー	❌	依存禁止

4. インポートパターン

4.1 インポート順序

// 1. 外部ライブラリ
// 2. 内部モジュール（絶対パス）
// 3. 相対インポート
// 4. スタイル・アセット

4.2 パスエイリアス

エイリアス	対象パス	用途
`@/`	`src/`	ソースコードルート

5. テスト構造

5.1 配置戦略

テスト種別	配置場所	命名規則
ユニットテスト	対象ファイルと同階層	`*.test.ts`
E2Eテスト	`tests/e2e/`	`*.e2e.test.ts`

6. Git規約

6.1 ブランチ命名

タイプ	パターン	例
機能開発	`feature/[id]-description`	`feature/001-user-auth`
バグ修正	`fix/[id]-description`	`fix/042-login-error`

6.2 コミットメッセージ

<type>(<scope>): <description>

type	用途
`feat`	新機能
`fix`	バグ修正
`docs`	ドキュメント

ドキュメント	説明	リンク
プロダクト定義書	ビジネス要件	product.md
技術定義書	技術スタック	tech.md