CLAUDE.md の正しい開き方

CLAUDE.md は、プロジェクトのルートディレクトリに配置される特別なファイルで、AI アシスタント（Claude など）にプロジェクトに関する重要な情報を伝えるために使用されます。このファイルを適切に記述することで、AI がより良く理解し、あなたを支援できるようになります。

なぜ CLAUDE.md が必要なのか？

新しい同僚が入社してきたとき、あなたが彼にあなたのプロジェクトを理解させるのにどれくらいの時間がかかるか想像してみてください。CLAUDE.md は、AI がすぐに使いこなせるようにするための「プロジェクト説明書」です。

CLAUDE.md の 5 つのコアコンテンツ

1. プロジェクト概要

このプロジェクトが何をするものなのか、どのような問題を解決するのか、どのようなユーザーを対象とするのかを簡単に説明します。

# プロジェクト概要 これは、商品、注文、およびユーザーを管理するための e コマースバックエンド管理システムです。

2. 技術スタック

プロジェクトで使用されている主要な技術とフレームワークをリストします。

`# 技術スタック

• フロントエンド：React + TypeScript
• バックエンド：Node.js + Express
• データベース：PostgreSQL
• デプロイ：Docker + Kubernetes`

3. ファイル構造

主要なディレクトリの役割を説明します。

# ファイル構造 /src /components - UI コンポーネント /pages - ページ /utils - ユーティリティ関数 /api - API 呼び出し

4. 一般的なコマンド

開発で一般的に使用されるコマンドをリストします。

# 一般的なコマンド npm run dev - 開発サーバーを起動 npm run build - 本番バージョンをビルド npm run test - テストを実行

5. ルール

AI がコードを記述する際に従うべきルールを定義します。

`# コーディングルール

• 関数型コンポーネントを使用する
• ESLint 設定に従う
• コンポーネントの命名には PascalCase を使用する
• 変数の命名には camelCase を使用する`

完全な例

`# プロジェクト名：Task Manager

プロジェクト概要

タスクの作成、編集、削除、および分類をサポートするシンプルなタスク管理アプリケーション。

技術スタック

• React 18
• TypeScript
• Tailwind CSS
• Vite

ファイル構造

/src /components - UI コンポーネント /hooks - カスタム Hooks /types - TypeScript 型定義 /utils - ユーティリティ関数

一般的なコマンド

• npm run dev: 開発サーバーを起動
• npm run build: 本番バージョンをビルド
• npm run lint: コードチェック

コーディング規約

• コンポーネントは関数型で記述する
• スタイルには Tailwind CSS を使用する
• 各コンポーネントは個別のフォルダに配置する`

ちょっとしたヒント

• 簡潔さを保つ：長すぎないようにする。AI も「疲れて」しまいます。
• 定期的に更新する：プロジェクトが変更された場合は、CLAUDE.md を更新することを忘れないでください。
• 例を優先する：抽象的な説明よりも具体的なコード例の方が効果的です。
• 痛点に注目する：エラーが発生しやすい箇所を重点的に説明します。

CLAUDE.md を適切に記述して、AI をあなたの強力なアシスタントにしましょう！