create-claude-workflow
v1.0.0
Published
Add Claude AI workflow files to any project - development diary, ADRs, and AI agents
Maintainers
Readme
Claude Template
A powerful template for AI-assisted development with Claude Code, featuring built-in development diary and Architecture Decision Records (ADRs) for maintaining project knowledge.
Quick Start
Installation (Works for both new and existing projects!)
# For a new project
npx create-claude-workflow my-project
# For an existing project
cd your-project
npx create-claude-workflowThe interactive CLI will:
- ✨ Detect if you're in a new or existing project
- 🔍 Check for existing Claude files
- 📋 Let you choose which components to add
- ⚡ Handle conflicts intelligently
- 🎯 Set up everything automatically
Manual Setup (Alternative)
- Clone this repository
- Copy the
templatedirectory contents to your project - Customize the files for your needs
What's Included
template/
├── CLAUDE.md # Main guidance file for Claude with interactive setup
├── .dev_diary/ # Development documentation system
│ ├── README.md # How to use the diary
│ ├── template.md # Entry template
│ └── adr/ # Architecture Decision Records
│ └── README.md # ADR guide and template
└── .claude/ # Claude Code configuration
└── agents/ # AI agents for parallel development
├── orchestrator.md # Coordinates multi-agent workflows
├── task-distributor.md # Analyzes and distributes tasks
├── tester.md # Testing and QA
└── reviewer.md # Code review and qualityFeatures
🤖 Interactive Setup
When you first use the template, Claude will:
- Ask about your project (name, purpose, commands)
- Help personalize all template sections
- Confirm before removing any template content
- Set up your project-specific documentation
📓 Development Diary
Track your development journey with:
- Structured templates for documenting work
- Investigation processes and failed attempts
- Implementation details and context
- Lessons learned for future reference
🏛️ Architecture Decision Records (ADRs)
Document important decisions with:
- Structured format for architectural choices
- Context, consequences, and alternatives
- Historical record of "why" decisions were made
- Template for consistent documentation
🚀 AI Agents for Parallel Development
Essential agents that enable efficient development workflows:
- Orchestrator: Coordinates multi-agent collaboration and tracks progress
- Task Distributor: Intelligently breaks down and assigns work
- Tester: Comprehensive testing and quality assurance
- Reviewer: Code review and best practices enforcement
- Parallel Execution: Multiple agents working simultaneously
- Universal Application: Works with any programming language or framework
How It Works
- Copy the template to your project using degit or git clone
- Open with Claude Code - Claude will notice the setup instructions
- Answer Claude's questions about your project
- Start developing with AI assistance and proper documentation
The template creates a sustainable workflow where both you and Claude can understand the project's evolution over time.
Best Practices
- Start Simple: Only include what's actually needed
- Be Specific: Generic advice doesn't help Claude
- Update Regularly: Keep CLAUDE.md current as the project evolves
- Document Patterns: Focus on non-obvious project conventions
- Include Examples: Real command examples work better than descriptions
Why Use This Template?
- Better AI Assistance: Claude understands your project structure and conventions
- Knowledge Preservation: Development decisions and context are never lost
- Team Collaboration: New developers (human or AI) can quickly understand the codebase
- Reduced Context Switching: All project knowledge in one place
- Future-Proof: Works with any programming language or framework
- Parallel Development: Multiple AI agents can work on different aspects simultaneously
- Quality Focus: Built-in testing and review agents ensure high-quality output
Contributing
Feel free to suggest improvements to this template structure.
License
MIT
