↓の記事で紹介したドキュメントのサンプル記述を紹介します。
CLAUDE.md
# Claude Code プロジェクト設定ドキュメント
## プロジェクト概要
**プロジェクト名**: [プロジェクト名を記入]
**開始日**: [YYYY-MM-DD形式で記入]
**完了予定日**: [YYYY-MM-DD形式で記入]
**プロジェクトの目的**: [プロジェクトの主目的を簡潔に記述]
## プロジェクト専用セーフティ設定(オプション)
### 概要
このプロジェクトでは、危険なコマンド(`rm -rf`等)以外は確認なしで自動実行する設定が可能です。
### ローカル設定ファイル
このプロジェクトのみで有効な設定:
```
[プロジェクトルート]/
├── .claude_code/
│ ├── settings.json # プロジェクト専用フック設定
│ └── check_safe_commands.py # 最小限のチェックスクリプト
```
### 有効化方法
プロジェクトルートで以下を実行:
```bash
# テンプレートからコピー(必要に応じて)
# テンプレートディレクトリから .claude_code をコピー
cp -r [テンプレートパス]/.claude_code ./
# スクリプトに実行権限を付与
chmod +x .claude_code/check_safe_commands.py
```
### 動作
- ✅ 通常のコマンド: 自動実行(確認なし)
- ⚠️ `rm -rf`等の危険コマンド: 確認後に実行
- 📁 このプロジェクト内でのみ有効(グローバル設定に影響しない)
### カスタマイズ
`.claude_code/check_safe_commands.py`を編集して、プロジェクト特有のルールを追加できます
## 技術スタック
### フロントエンド
- **フレームワーク**: [フロントエンドフレームワーク]
- **スタイリング**: [CSSフレームワーク]
- **状態管理**: [状態管理ライブラリ]
- **その他ライブラリ**: [主要なライブラリを列挙]
### バックエンド
- **フレームワーク**: [バックエンドフレームワーク]
- **データベース**: [データベース種類]
- **認証方式**: [認証方式]
- **その他ミドルウェア**: [ミドルウェア]
### インフラ・ツール
- **ホスティング**: [ホスティングサービス]
- **CI/CD**: [CI/CDツール]
- **コンテナ**: [コンテナ技術]
- **監視・ログ**: [監視ツール]
## 開発ルール
### コーディング規約
- **命名規則**:
- 変数名: [camelCase/snake_case]
- 関数名: [camelCase/snake_case]
- クラス名: [PascalCase]
- ファイル名: [kebab-case/camelCase]
- **インデント**: [スペース2つ/スペース4つ/タブ]
- **行末**: [セミコロンあり/なし]
- **文字コード**: UTF-8
- **改行コード**: [LF/CRLF]
### Git運用
- **ブランチ戦略**: [Git Flow/GitHub Flow/GitLab Flow]
- **コミットメッセージ形式**:
```
[type]: [subject]
[body]
[footer]
```
- type例: feat, fix, docs, style, refactor, test, chore
- **プルリクエスト**:
- レビュー必須: [Yes/No]
- 承認必要数: [1/2/3]
- 自動マージ: [有効/無効]
## エージェント活用方法
### 並列開発の基本原則
1. **独立性の確保**: 各エージェントのタスクは可能な限り独立させる
2. **明確な責任範囲**: エージェントごとの専門領域を明確に定義
3. **標準化された通信**: タスクテンプレートを使用した統一的な指示
4. **定期的な同期**: 進捗確認と調整のタイミングを設定
### エージェント間のコミュニケーション
- **タスク依頼形式**: TASK_TEMPLATES.mdに従う
- **進捗報告**: 標準フォーマットで報告
- **問題エスカレーション**: 明確なエスカレーションパス
- **成果物の受け渡し**: 定義されたインターフェースを通じて実施
## プロジェクト固有の注意事項
### セキュリティ
- [プロジェクト特有のセキュリティ要件を記載]
- [認証・認可の詳細]
- [データ保護の方針]
### パフォーマンス
- [目標とするレスポンスタイム]
- [同時接続数の想定]
- [データ量の見積もり]
### 制約事項
- [技術的制約]
- [ビジネス上の制約]
- [リソースの制約]
## 開発環境セットアップ
### 前提条件
- Node.js: [バージョン]
- Python: [バージョン]
- その他: [必要なツール・ソフトウェア]
### 初期設定手順
1. リポジトリのクローン
2. 依存関係のインストール
3. 環境変数の設定
4. データベースの初期化
5. 開発サーバーの起動
### 環境変数
```env
# 例
DATABASE_URL=[データベース接続文字列]
API_KEY=[APIキー]
SECRET_KEY=[秘密鍵]
```
## テスト戦略
### テストの種類
- **単体テスト**: [使用ツール、カバレッジ目標]
- **統合テスト**: [使用ツール、対象範囲]
- **E2Eテスト**: [使用ツール、主要シナリオ]
### テスト実行
```bash
# テストコマンド例
[test_command] # 単体テスト
[e2e_test_command] # E2Eテスト
```
## デプロイメント
### デプロイフロー
1. [ステップ1]
2. [ステップ2]
3. [ステップ3]
### 環境別設定
- **開発環境**: [URL、特徴]
- **ステージング環境**: [URL、特徴]
- **本番環境**: [URL、特徴]
## トラブルシューティング
### よくある問題と解決方法
1. **問題**: [問題の説明]
**解決**: [解決方法]
2. **問題**: [問題の説明]
**解決**: [解決方法]
## 参考リンク
- [プロジェクト管理ツール]: [URL]
- [デザインシステム]: [URL]
- [API ドキュメント]: [URL]
- [その他関連資料]: [URL]
## 更新履歴
- [YYYY-MM-DD]: [更新内容]
- [YYYY-MM-DD]: [更新内容]