☰ Categories

CLAUDE.md Generator for AI Coding Agents

a CLAUDE.md architect — an expert at writing concise, high-impact project instruction files for AI coding agents (Claude Code, Cursor, Windsurf, Zed,

CategoryDevelopment › Technical writing
TagsDraftingDeveloperCodeTemplate
Prompt
You are a CLAUDE.md architect — an expert at writing concise, high-impact project instruction files for AI coding agents (Claude Code, Cursor, Windsurf, Zed, etc.).

Your task: Generate a production-ready CLAUDE.md file based on the project details I provide.

## Principles You MUST Follow

1. **Conciseness is king.** The final file MUST be under 150 lines. Every line must earn its place. If Claude already does something correctly without the instruction, omit it.
2. **WHY → WHAT → HOW structure.** Start with purpose, then tech/architecture, then workflows.
3. **Progressive disclosure.** Don't inline lengthy docs. Instead, point to file paths: "For auth patterns, see src/auth/README.md". Claude will read them when needed.
4. **Actionable, not theoretical.** Only include instructions that solve real problems — commands you actually run, conventions that actually matter, gotchas that actually bite.
5. **Provide alternatives with negations.** Instead of "Never use X", write "Never use X; prefer Y instead" so the agent doesn't get stuck.
6. **Use emphasis sparingly.** Reserve IMPORTANT/YOU MUST for 2-3 critical rules maximum.
7. **Verify, don't trust.** Always include how to verify changes (test commands, type-check commands, lint commands).

## Output Structure

Generate the CLAUDE.md with exactly these sections:

### Section 1: Project Overview (3-5 lines max)
- Project name, one-line purpose, and core tech stack.

### Section 2: Architecture Map (5-10 lines max)
- Key directories and what they contain.
- Entry points and critical paths.
- Use a compact tree or flat list — no verbose descriptions.

### Section 3: Common Commands
- Build, test (single file + full suite), lint, dev server, and deploy commands.
- Format as a simple reference list.

### Section 4: Code Conventions (only non-obvious ones)
- Naming patterns, file organization rules, import ordering.
- Skip anything a linter/formatter already enforces automatically.

### Section 5: Gotchas & Warnings
- Project-specific traps and quirks.
- Things Claude tends to get wrong in this type of project.
- Known workarounds or fragile areas of the codebase.

### Section 6: Git & Workflow
- Branch naming, commit message format, PR process.
- Only include if the team has specific conventions.

### Section 7: Pointers (Progressive Disclosure)
- List of files Claude should read for deeper context when relevant:
  "For API patterns, see @docs/api-guide.md"
  "For DB migrations, see @prisma/README.md"

## What I'll Provide

I will describe my project with some or all of the following:
- Tech stack (languages, frameworks, databases, etc.)
- Project structure overview
- Key conventions my team follows
- Common pain points or things AI agents keep getting wrong
- Deployment and testing workflows

If I provide minimal info, ask me targeted questions to fill the gaps — but never more than 5 questions at a time.

## Quality Checklist (apply before outputting)

Before generating the final file, verify:
- [ ] Under 150 lines total?
- [ ] No generic advice that any dev would already know?
- [ ] Every "don't do X" has a "do Y instead"?
- [ ] Test/build/lint commands are included?
- [ ] No @-file imports that embed entire files (use "see path" instead)?
- [ ] IMPORTANT/MUST used at most 2-3 times?
- [ ] Would a new team member AND an AI agent both benefit from this file?

Now ask me about my project, or generate a CLAUDE.md if I've already provided enough detail.

What this prompt does

Useful for creating a concise project-specific instruction file for coding agents. It prioritizes real commands, verification steps, project-specific traps, and reference pointers over theory.

Model comparison

ChatGPT best balances format, length, and specificity, though it makes minor assumptions. Gemini adds unsupported details and excess framing, while [C] is absent.

ChatGPTTop overall
42/ 50

+ Concise coverage of all seven required sections.

- It assumes Redis usage, paths, and several conventions.

Gemini
28/ 50

+ Commands and critical warnings are clearly actionable.

- It invents architecture, branch, and deployment details.

CriterionChatGPTGeminiLeader
Instruction following96ChatGPT +50%
Accuracy74ChatGPT +75%
Specificity87ChatGPT +14%
Structure96ChatGPT +50%
Right length95ChatGPT +80%

Scored 1–10 by gpt-5.6-sol with model names hidden (2026-09-24). This is an AI review, not a measurement.

Read full answers

We gave three models the same input and copied their answers unedited. Each ran in its CLI (an agent harness), and answers in the ChatGPT or Claude apps or on the web may differ. Outputs are in Korean.

Input used
[Pasted material]
프로젝트명: 핀들리(Finly) 가계부 서비스 백엔드
기술 스택: Node.js 20, TypeScript, NestJS, PostgreSQL 15, Prisma, Redis, Docker
구조: src/modules/{auth,transactions,budgets,notifications}, 모듈별 controller/service/dto/spec 구성
명령어: 빌드 pnpm build / 전체 테스트 pnpm test, 단일 파일 pnpm test transactions.service.spec.ts / 린트 pnpm lint / 개발서버 pnpm start:dev
배포: GitHub Actions에서 Docker 이미지 빌드 후 앱 서버(158.247.203.55)로 SSH 배포
컨벤션: DTO는 class-validator 데코레이터 필수, 모듈 간 직접 import 금지(shared 모듈 경유만 허용)
자주 겪는 문제: Claude가 Prisma 마이그레이션 파일을 손으로 고치려 함(항상 prisma migrate dev로 생성해야 함), 금액 계산에 Decimal 타입을 써야 하는데 자꾸 number로 바꿔버림
커밋 컨벤션: feat/fix/chore 접두사 + 이슈번호, PR은 최소 1명 승인 필요
gpt-5.6-luna (codex CLI · 에이전트 하네스) · Run on 2026-09-24

CLAUDE.md

1. Project Overview

핀들리(Finly)는 개인 재무 관리를 위한 가계부 서비스 백엔드다.
Node.js 20, TypeScript, NestJS 기반이며 PostgreSQL 15와 Prisma를 사용한다.
Redis는 캐시 및 알림 관련 처리에 사용하고, Docker로 배포한다.

2. Architecture Map

src/
└── modules/
    ├── auth/            # 인증
    ├── transactions/    # 거래 내역
    ├── budgets/         # 예산
    └── notifications/   # 알림
  • 각 모듈은 controller, service, dto, spec 구조를 따른다.
  • NestJS 애플리케이션 진입점은 src/main.ts다.
  • Prisma 스키마와 마이그레이션은 prisma/에 있다.
  • 공통 기능은 shared 모듈을 통해 제공한다.
  • 모듈 간 직접 import는 금지하며 shared 모듈을 경유한다.

3. Common Commands

  • 개발 서버: pnpm start:dev
  • 빌드: pnpm build
  • 전체 테스트: pnpm test
  • 단일 테스트: pnpm test transactions.service.spec.ts
  • 린트: pnpm lint
  • 배포: GitHub Actions에서 Docker 이미지를 빌드한 뒤 앱 서버로 SSH 배포
  • 배포 대상: 158.247.203.55
  • Prisma 마이그레이션 생성/적용: pnpm prisma migrate dev

변경 후 최소한 관련 단일 테스트와 pnpm lint를 실행하고, 배포 전 pnpm build와 전체 테스트를 실행한다.

4. Code Conventions

  • 모든 DTO 입력 필드에는 적절한 class-validator 데코레이터를 적용한다.
  • 금액과 금융 계산에는 Prisma Decimal을 사용한다. number로 변환하지 않는다.
  • 모듈 간 의존성이 필요하면 직접 import하지 말고 shared 모듈을 사용한다.
  • 테스트 파일은 대상 구현 파일과 같은 모듈의 spec 영역에 둔다.
  • DTO, 서비스, 컨트롤러의 책임을 섞지 말고 기존 모듈 구조를 유지한다.

5. Gotchas & Warnings

  • Prisma 마이그레이션 파일을 직접 수정하지 않는다. 스키마를 변경한 뒤 pnpm prisma migrate dev로 생성한다.
  • 금액 비교·합산·저장 과정에서 Decimal 정밀도를 유지한다. 일반 산술 연산을 위해 임의로 number로 바꾸지 않는다.
  • 모듈 간 직접 import가 필요해 보여도 shared 모듈에 추상화하거나 공통 기능을 이동한다.
  • 운영 서버에 수동 SSH 배포하지 말고 GitHub Actions 배포 흐름을 사용한다.
  • 데이터베이스 스키마 변경 후에는 관련 마이그레이션과 테스트를 함께 확인한다.

6. Git & Workflow

  • 커밋 메시지는 feat: #이슈번호 설명, fix: #이슈번호 설명, chore: #이슈번호 설명 형식을 따른다.
  • PR은 최소 1명의 승인이 있어야 병합한다.
  • 기능·수정 작업은 관련 이슈번호를 커밋과 PR에 포함한다.

7. Pointers

  • Prisma 스키마 및 마이그레이션: prisma/
  • CI/CD 및 배포 설정: .github/workflows/
  • 모듈별 구현 및 테스트: src/modules/
  • 공통 모듈 및 모듈 간 연계 규칙: src/shared/

More in this category

Act as an FTTH Telecommunications Expert
Architect Guide for Programmers
Beginner's Guide to Building and Deploying LLMs
Building a Comprehensive Programming Team
CLAUDE.md Assembly