w3-generate-claude-files
npx skills add https://github.com/famtong8-dev/w3-generate-claude-files --skill w3-generate-claude-files
Agent 安装分布
Skill 文档
ð Generate Claude Files – Multi-Language Documentation
Generate CLAUDE.md, CODEMAP.md, and MEMORY.md for your backend project using prompts and analysis (not automated code generation).
Supported Languages: Node.js/JavaScript ⢠Python ⢠Go ⢠Java ⢠C# ⢠Ruby ⢠PHP ⢠And more!
ð¯ What This Skill Does
This skill helps you create three essential AI collaboration files for ANY backend project:
-
CLAUDE.md – Project Constitution
- Project rules, conventions, tech stack
- Critical coding standards
- How to add features
- Language-specific best practices
-
CODEMAP.md – Codebase Architecture Map
- Directory structure with purposes
- Request/response flow diagrams
- Navigation guides
- Framework-specific patterns
-
MEMORY.md – Project Context & Knowledge Base
- Quick facts and architecture overview
- Code patterns and conventions
- Known gotchas and solutions
- Performance and security notes
- Language-specific tips
Approach: Interactive prompts + manual analysis â personalized, accurate documentation for YOUR tech stack
â¡ Quick Start (15 minutes)
Step 1: Get the Quick Start Prompts
Open: references/QUICK_START_PROMPTS.md
Step 2: Answer Phase 1 Questions
Copy the Phase 1 prompt â Paste into Claude
Answer questions about your project
Get structured analysis
Step 3: Generate Documentation
Use Phase 2 prompt â Get CLAUDE.md
Use Phase 3 prompt â Get CODEMAP.md
Use Phase 4 prompt â Get MEMORY.md
Step 4: Use Your Documentation
Review and customize the generated files, then use them in your Claude requests.
â¡ Optimization: Faster Generation with External Tools
Save time and tokens by using these CLI tools if available:
Option A: Use Existing Codemap
If you already have a CODEMAP.md:
- Skip Phase 3 (CODEMAP generation)
- Use existing codemap in Phase 2 analysis
- Saves: 10-15 minutes + 20% tokens
Option B: Generate Codemap with CLI (CLI Tool)
Generate project structure map with codemap CLI:
codemap --output project-structure.md
Then use output in Phase 1 to inform CODEMAP generation
- Saves: 10-15 minutes + simplifies Phase 3 (CODEMAP)
- Best for: Understanding complex project layouts
Option C: Use repomix (CLI Tool)
Generate token-lean context with repomix CLI:
repomix --output context.md
Then paste the output into Phase 1 for comprehensive analysis
- Saves: 15-20 minutes + 30% tokens
Option D: Use mgrep (CLI Tool)
Before Phase 1, run mgrep to extract code patterns:
mgrep "error handling" src/
mgrep "validation" src/
mgrep "interface\|type" src/
Collect key patterns and feed into Phase 1
- Saves: 10 minutes + gives Phase 1 better answers
Option E: Combined Optimization (Recommended) â¡
- Generate codemap structure:
codemap --output project-structure.md - Generate repomix context:
repomix --output context.md - Run mgrep for patterns:
mgrep "pattern" src/ - Feed all outputs into Phase 1 for comprehensive analysis
- Result: 20-25 min instead of 45-60 min + 50% token savings
ð How to Use This Skill
Option 1: Super Quick (15 min) ð
Use QUICK_START_PROMPTS.md
- Copy Phase 1 prompt â analyze your repo
- Copy Phase 2-4 prompts â generate files
- Done!
Option 2: Thorough (45-60 min) ð
Use PROMPT_BASED_WORKFLOW.md
- 4 detailed phases with templates
- Complete section-by-section
- Professional quality output
Option 3: AI-Assisted (30 min) ð¤
Hybrid approach
- Do Phase 1 analysis manually (15 min)
- Use prompts with Claude (10 min)
- Review & customize (5 min)
ð Documentation Files
Main Guides
| File | Purpose | When to Use |
|---|---|---|
| HOW_TO_USE_THIS_SKILL.md | Overview & quick start | Start here first |
| PROMPT_BASED_WORKFLOW.md | Detailed 4-phase guide | Want detailed guidance |
| QUICK_START_PROMPTS.md | Ready-to-use prompts | Want fastest approach |
Templates & References
| File | Purpose |
|---|---|
| CLAUDE.md.template | Template for project constitution |
| CODEMAP.md.template | Template for architecture map |
| MEMORY.md.template | Template for context knowledge |
ð The 4 Phases
Phase 1: Repository Analysis (15-20 min)
You do: Explore your project, answer questions about:
- Project identity (name, purpose, type)
- Technology stack
- Directory structure
- Code patterns
- Known pain points
Output: Structured analysis answers
Phase 2: Generate CLAUDE.md (5-10 min)
Claude generates: Project constitution containing:
- Tech stack overview
- Critical coding rules
- Code quality standards
- How to add features
- Pre-commit checklist
Phase 3: Generate CODEMAP.md (10-15 min)
Claude generates: Architecture map showing:
- Directory structure & purposes
- Request flow diagram
- File quick reference
- Navigation guides
Phase 4: Generate MEMORY.md (10-15 min)
Claude generates: Context knowledge including:
- Quick facts table
- Code patterns & conventions
- Known gotchas & solutions
- Performance notes
- Security checklist
ð What You Get
CLAUDE.md – Project Constitution
â Tech stack details specific to your project â Critical coding rules (validation, error handling, testing, language-specific standards) â Project structure documentation â Step-by-step feature addition guide â Pre-commit verification checklist â Decision matrix (when to ask vs. when to decide)
CODEMAP.md – Architecture Map
â Directory structure with clear purposes â Service layer and pattern documentation â Middleware and utility overview â Request flow diagrams â File location quick reference â How to navigate and find code
MEMORY.md – Context Knowledge
â Quick facts table (tech, deployment, auth) â Architecture diagrams â Code conventions with real examples â Known gotchas and their solutions â Performance issues and fixes â Security measures checklist â Testing patterns
ð¡ Why This Approach?
Advantages of Prompts vs. Code Generation
⨠Accurate – Based on YOUR actual code, not generic templates ⨠Personalized – Reflects your project’s specific patterns & gotchas ⨠Conversational – Interactive with Claude to clarify details ⨠Understandable – Claude asks for clarification when needed ⨠Flexible – Easy to customize generated output
ð¯ When to Use This Skill
â Perfect for:
- Starting a new backend project (any language)
- Onboarding to an existing codebase
- Creating AI-collaboration documentation
- Documenting microservices, APIs, or services
- Documenting team projects consistently
- Multi-language/polyglot teams
â Supported Languages & Frameworks:
Node.js/JavaScript
- Frameworks: Express, Fastify, NestJS, Koa
- Testing: Jest, Vitest, Mocha
- Databases: PostgreSQL, MongoDB, MySQL, SQLite
Python
- Frameworks: Django, FastAPI, Flask, Starlette
- Testing: pytest, unittest
- ORMs: SQLAlchemy, Django ORM, Tortoise-ORM
- Databases: PostgreSQL, MySQL, SQLite
Go
- Frameworks: Gin, Echo, Chi, Fiber
- Testing: testing package, Testify, GoConvey
- Databases: PostgreSQL, MySQL, SQLite
Other Languages (with adaptation):
- Java (Spring Boot, Quarkus)
- C# (.NET, ASP.NET Core)
- Ruby (Rails, Sinatra)
- PHP (Laravel, Symfony)
â Supported Infrastructure:
- REST APIs
- GraphQL Services
- Microservices
- Event-driven systems
- Message queues (RabbitMQ, Kafka, Redis)
- Background jobs
- Monoliths & distributed systems
ð Skill Structure
w3-generate-claude-files/
âââ SKILL.md â You are here
âââ references/
âââ HOW_TO_USE_THIS_SKILL.md â Start here
âââ PROMPT_BASED_WORKFLOW.md â Detailed guide
âââ QUICK_START_PROMPTS.md â Copy-paste prompts
âââ CLAUDE.md.template â Template reference
âââ CODEMAP.md.template â Template reference
âââ MEMORY.md.template â Template reference
ð Before You Start
You’ll need:
â A backend project (Node.js, Python, Go, Java, C#, etc.) â Basic knowledge of your project structure â ~15-60 minutes depending on project size â Claude AI access for prompt-based generation â Know your tech stack (framework, database, testing tools)
ð Example: What Gets Generated
For a Simple Express API (15 min)
CLAUDE.md ~500 lines (rules + patterns)
CODEMAP.md ~400 lines (structure + flow)
MEMORY.md ~300 lines (context + gotchas)
For a Medium NestJS Service (45 min)
CLAUDE.md ~800 lines (detailed rules)
CODEMAP.md ~600 lines (complex architecture)
MEMORY.md ~500 lines (comprehensive context)
For a Large Microservices Platform (60 min)
CLAUDE.md ~1000+ lines (extensive standards)
CODEMAP.md ~800+ lines (detailed maps)
MEMORY.md ~700+ lines (complete knowledge)
ð Getting Started Right Now
Step 1: Choose Your Approach
- Quick? â Use QUICK_START_PROMPTS.md
- Thorough? â Use PROMPT_BASED_WORKFLOW.md
- Hybrid? â Do Phase 1, then use prompts
Step 2: Open the Guide
references/HOW_TO_USE_THIS_SKILL.md
Step 3: Follow the Workflow
- Answer analysis questions
- Use copy-paste prompts
- Review generated files
- Customize as needed
Step 4: Use Your Documentation
In future Claude requests, reference your generated files:
"See CLAUDE.md, CODEMAP.md, MEMORY.md for context"
ð¬ Using Generated Files in Claude Requests
Before: Generic Explanations Needed
"Add user authentication"
â Claude: "What framework? JWT or session? Where's your auth middleware?"
â Back and forth for 20+ minutes
After: Instant Understanding
"Add user authentication
See CLAUDE.md, CODEMAP.md, MEMORY.md"
â Claude: Already knows your tech stack, patterns, and conventions
â Generates code in 5 minutes matching YOUR project style
â Quick FAQ
Q: How long does it take? A: 15 min (quick) to 60 min (thorough) depending on project size
Q: Do I need to write code? A: No! This is purely prompts and analysis
Q: Works with all languages? A: Yes! Node.js, Python, Go, Java, C#, Ruby, PHP – any backend stack
Q: Will files stay updated? A: You update manually as project evolves
Q: Multi-language teams? A: Perfect! Creates shared documentation for any tech stack
ð Next Steps
- Open HOW_TO_USE_THIS_SKILL.md
- Choose your approach (Quick/Thorough/Hybrid)
- Follow the workflow
- Generate your documentation files
- Use in all future Claude requests
ð Related Tools & Resources
Complementary CLI Tools (for optimization):
codemap– Generate project structure visualization and architecture mapsrepomix– Generate token-lean repository contextmgrep– Extract code patterns and conventions
Using Generated Files:
- Paste CLAUDE.md, CODEMAP.md, MEMORY.md into future Claude requests
- Reference them with: “See CLAUDE.md, CODEMAP.md, MEMORY.md for context”
Last Updated: February 2026 Approach: Prompt-based (not code generation) Status: Ready to use â