CLAUDE.md のベストプラクティス

コマンド / 機能

効果的な CLAUDE.md の書き方

実践的なガイドライン

概要

CLAUDE.md を効果的に活用するためのベストプラクティス。構造化、具体性、保守性を意識した書き方。

設定例

# CLAUDE.md ベストプラクティス

## 1. 構造化する
見出しを使って整理:
- ## プロジェクト概要
- ## 技術スタック
- ## コーディング規約
- ## ディレクトリ構造
- ## よく使うコマンド

## 2. 具体的に書く
❌ 悪い例: きれいなコードを書いて
✅ 良い例:
- 関数は20行以内
- ネストは3階層まで
- 変数名は purpose を表す名前に

## 3. 優先順位を明示
重要なルールには強調を:
**必須**: TypeScript の strict モードを使用
**推奨**: 関数型アプローチを優先
**禁止**: any 型の使用

## 4. 例を含める
```typescript
// 良い例
const getUserById = async (id: string): Promise<User> => {
  // ...
};

// 悪い例
const get = async (x) => {
  // ...
};
```

## 5. 更新しやすく保つ
- 古くなったルールは削除
- 定期的にレビュー
- 分割が必要になったら .claude/rules/ へ

---
# 完全な CLAUDE.md テンプレート

# プロジェクト: [プロジェクト名]

## 概要
[1-2文でプロジェクトの説明]

## 技術スタック
- 言語:
- フレームワーク:
- データベース:
- その他:

## コーディング規約
### 命名規則
-

### ファイル構成
-

### インポート順序
1.
2.
3.

## よく使うコマンド
```bash
npm run dev      # 開発サーバー
npm run test     # テスト
npm run build    # ビルド
```

## 重要な注意事項
-
-