Update and maintain project documentation for CLAUDE.md and README.md:
- CLAUDE.md Management
Purpose: Keep Claude's project instructions current and accurate
-
Scan project structure: Check for new tools, scripts, build systems
-
Update build commands: Sync with package.json, Makefile, or build configs
-
Add new patterns: Document coding conventions, file organization
-
Refresh tool commands: Update linting, testing, deployment instructions
-
Check environment setup: Verify installation and setup steps
- README.md Maintenance
Purpose: Keep public project documentation up-to-date
-
Update installation: Check dependencies, requirements, setup steps
-
Refresh usage examples: Verify code samples and API documentation
-
Validate links: Test external links, badges, and references
-
Update project status: Current features, roadmap, version info
-
Check screenshots/demos: Ensure visual examples are current
- Smart Detection Process
-
File existence: Create CLAUDE.md or README.md if missing
-
Project analysis: Scan codebase for changes since last update
-
Cross-reference: Compare project structure with documented instructions
-
Outdated sections: Identify stale information automatically
-
Consistency check: Ensure both files complement each other
- Validation Steps
-
Run project commands mentioned in docs to verify they work
-
Test installation steps from scratch perspective
-
Validate all external links and references
-
Check that CLAUDE.md instructions match current project setup
-
Ensure README.md accurately represents current project state
Focus on keeping both files synchronized with the actual project state and useful for their respective audiences: Claude for CLAUDE.md, users/developers for README.md.