ガイド一覧

はじめてのCLAUDE.md

このガイドでは、5分でCLAUDE.mdを書き始める方法を説明します。完璧を目指す必要はありません。最初は3セクションだけで十分です。

ステップ1: ファイルを作成する

プロジェクトのルートディレクトリで:

touch CLAUDE.md

ステップ2: 基本情報を書く

以下の3セクションから始めましょう:

1. プロジェクト概要

Claudeにプロジェクトの全体像を伝えます。

# MyApp

React + TypeScriptで構築されたタスク管理アプリ。
Supabaseをバックエンドに使用。

2. コマンド一覧

よく使うコマンドを列挙します。Claudeはこれを使ってテストやビルドを実行します。

## コマンド

- \`npm run dev\` — 開発サーバー起動
- \`npm run build\` — プロダクションビルド
- \`npm test\` — テスト実行
- \`npm run lint\` — Lint実行

3. コーディング規約

最も重要なルールだけ書きます。

## コーディング規約

- TypeScript strict モードを使用
- コンポーネントは関数コンポーネント + hooks
- スタイリングはTailwind CSS
- テストはVitest + Testing Library

ステップ3: 効果を確認する

CLAUDE.mdを保存したら、Claude Codeで何か作業を依頼してみてください。Claudeが規約に沿ったコードを生成することが確認できるはずです。

よくある間違い

  • 書きすぎる — 最初から完璧なドキュメントを目指さない
  • 抽象的すぎる — 「きれいなコードを書く」ではなく具体的なルールを書く
  • 更新しない — プロジェクトの進化に合わせて定期的に見直す

次のステップ

基本ができたら、以下を追加していきましょう:

  • ディレクトリ構造の説明
  • Git/ブランチ戦略
  • 環境変数の一覧
  • デプロイ手順

検索

ガイドやテンプレートを検索...