ファイル作成初級
README から CLAUDE.md への移行
README に散在するセットアップ情報を Claude Code 向けの CLAUDE.md に再構成するプロンプト。
監修: 平原尚樹
株式会社BlueAI 代表取締役CEO / ソフトウェアエンジニア / プロダクトエンジニア / Google Cloud Architect / 元AIスタートアップ(Doorkel)
監修: 酒井歩乃加
早稲田大学文化構想学部卒業 / フリーランス編集者・ライター / 元マイベスト編集ディレクター / SEO対策記事・取材記事執筆
こんな課題を解決
README は人間向けに書かれており冗長。Claude Code が必要とするコマンドや規約だけ抜き出した CLAUDE.md を作りたい。
プロンプト
Claude Code に入力
README.md と各種設定ファイルから CLAUDE.md を新規作成してください。
## 抽出元
- README.md / CONTRIBUTING.md / docs/ 配下
- package.json scripts / Makefile
- .editorconfig / eslint.config / tsconfig
## CLAUDE.md に含める項目
1. プロジェクト 1 行サマリ
2. ディレクトリ構成(mono repo の場合は workspace 一覧)
3. 開発コマンド(make dev, bun test, など)
4. 命名・スタイル規約(生タグ禁止、コンポーネント名など)
5. データ層の方針(ORM、マイグレーション)
6. テスト・デプロイ手順
7. やってはいけないこと(force push、本番 DB 直接編集など)
## 守ること
- 200 行以内に収める
- 重複情報は README に残し、CLAUDE.md からはリンクで参照
- 例より規約を優先(Claude は規約があれば再現できる)実行結果の例
Claude Code が以下を生成します。 - /CLAUDE.md(180 行、表とリスト中心) - 抽出元と未反映情報のサマリ - 既存 README から削除候補のセクション提案
コツ・ポイント
- /init コマンドの結果と diff を取りつつ統合すると漏れが少ない
- 巨大モノレポは apps/* ごとに CLAUDE.md を置く構成が有効
- ユーザー向け文言ルールは Claude が外しがちなので冒頭に書く
- 完成後にチームでレビューし、合意を取ってからコミット