mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-01 15:03:57 +08:00
- Updated command syntax formatting to use code blocks for clarity in `prep.md`, `review.md`, and `spec.md`. - Enhanced architectural diagrams in `ch01-what-is-claude-dms3.md` and core concepts in `ch03-core-concepts.md` using mermaid syntax for better visualization. - Improved workflow diagrams in `ch04-workflow-basics.md` and `4-level.md` to provide clearer representations of processes. - Added troubleshooting section in `installation.md` to address common installation issues and provide quick start examples. - Revised skill documentation in `claude-meta.md` and `claude-workflow.md` to standardize command triggers and output structures. - Updated best practices and workflow index documentation to enhance readability and understanding of workflow levels and practices.
4.3 KiB
4.3 KiB
Workflow Best Practices
Optimize your CCW workflows for maximum efficiency and quality.
Specification Phase
DO
- Start with clear objectives: Define success criteria upfront
- Involve stakeholders: Gather requirements from all stakeholders
- Document assumptions: Make implicit knowledge explicit
- Identify risks early: Assess technical and project risks
DON'T
- Skip research phase
- Assume requirements without validation
- Ignore technical constraints
- Over-engineer solutions
Planning Phase
DO
- Break down tasks: Granular tasks are easier to estimate
- Map dependencies: Identify task relationships early
- Estimate realistically: Use historical data for estimates
- Plan for iteration: Include buffer for unknowns
DON'T
- Create monolithic tasks
- Ignore task dependencies
- Underestimate complexity
- Plan everything upfront
Implementation Phase
DO
- Follow the plan: Trust the planning process
- Test as you go: Write tests alongside code
- Document changes: Keep documentation in sync
- Validate frequently: Run tests after each change
DON'T
- Deviate from the plan without discussion
- Skip testing for speed
- Defer documentation
- Ignore feedback
Validation Phase
DO
- Test comprehensively: Cover happy paths and edge cases
- Review code: Use code review guidelines
- Measure quality: Use automated metrics
- Document findings: Create test reports
DON'T
- Skip edge case testing
- Ignore review feedback
- Rely on manual testing only
- Hide test failures
Team Coordination
Communication
- Use SendMessage: Always communicate through coordinator
- Be specific: Clear messages reduce back-and-forth
- Report progress: Update status regularly
- Escalate blockers: Don't wait on blockers
Collaboration
- Respect boundaries: Each role has specific responsibilities
- Trust the process: The workflow ensures quality
- Share knowledge: Contribute to wisdom files
- Learn from failures: Post-mortems improve future workflows
Common Pitfalls
Specification
| Pitfall | Impact | Prevention |
|---|---|---|
| Vague requirements | Rework | Use acceptance criteria |
| Missing constraints | Failed implementation | List NFRs explicitly |
| Unclear scope | Scope creep | Define in/out scope |
Planning
| Pitfall | Impact | Prevention |
|---|---|---|
| Optimistic estimates | Delays | Use cone of uncertainty |
| Unknown dependencies | Blocked tasks | Explore codebase first |
| Single-threaded planning | Bottlenecks | Identify parallel opportunities |
Implementation
| Pitfall | Impact | Prevention |
|---|---|---|
| Skipping tests | Bugs in production | Test-first approach |
| Ignoring feedback | Rejected PRs | Address review comments |
| Gold plating | Delayed delivery | Follow requirements |
Workflow Optimization
Reduce Cycle Time
- Batch similar tasks: Reduce context switching
- Automate validation: Continuous integration
- Parallel execution: Identify independent tasks
- Fast-advance: Skip coordinator for simple successions
Improve Quality
- Early validation: Test-first development
- Peer review: Multiple reviewer perspectives
- Automated testing: Comprehensive test coverage
- Metrics tracking: Measure quality indicators
Scale Effectively
- Epic decomposition: Large projects → epics → tasks
- Team specialization: Role-based agent assignment
- Knowledge sharing: Wisdom accumulation
- Process refinement: Continuous improvement
Examples
Good Workflow
[Specification]
↓ Clear requirements with acceptance criteria
[Planning]
↓ Realistic estimates with identified dependencies
[Implementation]
↓ Tests pass, documentation updated
[Validation]
↓ All acceptance criteria met
[Complete]
Problematic Workflow
[Specification]
↓ Vague requirements, no acceptance criteria
[Planning]
↓ Optimistic estimates, missed dependencies
[Implementation]
↓ No tests, incomplete documentation
[Validation]
↓ Failed tests, missing requirements
[Rework]
::: info See Also
- 4-Level System - Detailed workflow explanation
- Agents - Agent capabilities :::