Skip to content

Best Practices

One-Line Positioning

Best Practices ensure efficient team collaboration — Practical experience summary on standard formulation, code review, documentation maintenance, and team collaboration.


6.1 Team Collaboration Standards

6.1.1 Role Responsibility Definitions

RoleResponsibilitySkill Requirements
PlannerRequirement analysis, task breakdownArchitectural thinking, communication skills
DeveloperCode implementation, unit testingCoding ability, testing awareness
ReviewerCode review, quality gatekeepingCode sensitivity, standard understanding
QAQuality assurance, test verificationTest design, risk identification
FacilitatorCoordination, progress trackingProject management, conflict resolution

6.1.2 Workflow Selection

ScenarioRecommended WorkflowRationale
New Feature DevelopmentPlanExPlanning-execution separation, reduces risk
Bug FixLifecycleComplete closed loop, ensures fix quality
Code RefactoringIterDevIterative improvement, continuous optimization
Technical DecisionBrainstormMulti-perspective analysis, comprehensive consideration
Issue ManagementIssueTraceable, manageable
UI DevelopmentUIDesignSeamless design-to-code transition

6.1.3 Communication Protocols

Message Format

[<Role>] <Action> <Object>: <Result>

Examples:
[Planner] Task breakdown complete: Generated 5 subtasks
[Developer] Code implementation complete: user-auth.ts, 324 lines
[Reviewer] Code review complete: Found 2 issues, suggested 1 optimization

Status Reporting

StatusMeaningNext Action
pendingPendingWait for dependencies to complete
in_progressIn progressContinue execution
completedCompletedCan be depended upon
blockedBlockedManual intervention required

6.2 Code Review Process

6.2.1 Review Dimensions

DimensionCheck ItemsSeverity
CorrectnessLogic correct, boundary handlingHIGH
PerformanceAlgorithm efficiency, resource usageMEDIUM
SecurityInjection vulnerabilities, permission checksHIGH
MaintainabilityCode clarity, modularityMEDIUM
Test CoverageUnit tests, boundary testsMEDIUM
Standard ComplianceCoding standards, project conventionsLOW

6.2.2 Review Process

6.2.3 Review Checklist

Code Correctness

  • [ ] Logic correct, no bugs
  • [ ] Boundary condition handling
  • [ ] Complete error handling
  • [ ] Proper resource cleanup

Performance

  • [ ] Reasonable algorithm complexity
  • [ ] No memory leaks
  • [ ] No redundant computation
  • [ ] Reasonable caching strategy

Security

  • [ ] No SQL injection
  • [ ] No XSS vulnerabilities
  • [ ] Complete permission checks
  • [ ] Sensitive data protection

Maintainability

  • [ ] Clear naming
  • [ ] Good modularity
  • [ ] Sufficient comments
  • [ ] Easy to test

Test Coverage

  • [ ] Complete unit tests
  • [ ] Boundary test coverage
  • [ ] Exception case testing
  • [ ] Integration test verification

Standard Compliance

  • [ ] Unified coding style
  • [ ] Naming standard compliance
  • [ ] Project convention adherence
  • [ ] Complete documentation

6.2.4 Feedback Format

markdown
## Review Results

### Issues
1. **[HIGH]** SQL injection risk
   - Location: `src/auth/login.ts:45`
   - Recommendation: Use parameterized queries

2. **[MEDIUM]** Performance issue
   - Location: `src/utils/cache.ts:78`
   - Recommendation: Use LRU cache

### Suggestions
1. Naming optimization: `data``userData`
2. Module separation: Consider extracting Auth logic independently

### Approval Conditions
- [ ] Fix HIGH issues
- [ ] Consider MEDIUM suggestions

6.3 Documentation Maintenance Strategy

6.3.1 Documentation Classification

TypeLocationUpdate FrequencyOwner
Spec Documents.workflow/specs/As neededArchitect
Reference Docsdocs/ref/Every changeDeveloper
Guide Docsdocs/guide/MonthlyTechnical Writer
API Docsdocs/api/Auto-generatedTools
FAQdocs/faq.mdWeeklySupport Team

6.3.2 Documentation Update Triggers

EventUpdate Content
New FeatureAdd feature documentation and API reference
Spec ChangeUpdate spec documents and migration guide
Bug FixUpdate FAQ and known issues
Architecture ChangeUpdate architecture docs and decision records
Code ReviewSupplement missing comments and docs

6.3.3 Documentation Quality Standards

StandardRequirement
AccuracyConsistent with actual code
CompletenessCover all public APIs
ClarityEasy to understand, sufficient examples
TimelinessUpdated promptly, not lagging
NavigabilityClear structure, easy to find

6.4 Memory Management Best Practices

6.4.1 Memory Recording Triggers

TriggerRecord Content
Architecture DecisionsTechnology selection, design decisions
Problem ResolutionBug root cause, solutions
Experience SummaryBest practices, gotchas
Standard ConventionsCoding standards, naming conventions
Known IssuesBugs, limitations, TODOs

6.4.2 Memory Format Standards

markdown
## [Type] Title

### Background
- **Problem**: ...
- **Impact**: ...
- **Context**: ...

### Analysis/Decision
- **Solution**: ...
- **Rationale**: ...
- **Alternatives**: ...

### Result
- **Effect**: ...
- **Data**: ...

### Related
- [Related Memory](memory-id)
- [Related Code](file-link)
- [Related Documentation](doc-link)

6.4.3 Memory Maintenance

Maintenance ItemFrequencyContent
DeduplicationWeeklyMerge duplicate memories
UpdateAs neededUpdate outdated content
ArchiveMonthlyArchive historical memories
CleanupQuarterlyDelete useless memories

6.5 Hook Usage Standards

6.5.1 Hook Types

Hook TypePurposeExample
pre-commandInject specifications, load contextAuto-load CLAUDE.md
post-commandSave Memory, update indexAuto-save decisions
pre-commitCode review, standard checksAuto-run Lint
file-changeAuto-format, update indexAuto-format code

6.5.2 Hook Configuration Principles

PrincipleDescription
MinimizeOnly configure necessary Hooks
IdempotentHook execution results are repeatable
RecoverableHook failure doesn't affect main flow
ObservableHook execution has logging

6.6 Team Collaboration Techniques

6.6.1 Conflict Resolution

Conflict TypeResolution Strategy
Standard ConflictTeam discussion, unify standards
Technical DisagreementBrainstorm, data-driven
Schedule ConflictPriority sorting, resource adjustment
Quality ConflictSet standards, automated checks

6.6.2 Knowledge Sharing

MethodFrequencyContent
Tech SharingWeeklyNew technologies, best practices
Code WalkthroughEvery PRCode logic, design approach
Documentation SyncMonthlyDocumentation updates, standard changes
Incident RetrospectiveEvery incidentRoot cause analysis, improvements

6.6.3 Efficiency Improvement

TechniqueEffect
TemplatingReuse successful patterns
AutomationReduce repetitive work
ToolingImprove development efficiency
StandardizationLower communication cost

6.7 Quick Reference

Workflow Selection Guide

ScenarioWorkflowCommand
New FeaturePlanEx/workflow-plan
Bug FixLifecycle/unified-execute-with-file
RefactoringIterDev/refactor-cycle
DecisionBrainstorm/brainstorm-with-file
UI DevelopmentUIDesign/workflow:ui-design

Code Review Checklist

  • [ ] Correctness check
  • [ ] Performance check
  • [ ] Security check
  • [ ] Maintainability check
  • [ ] Test coverage check
  • [ ] Standard compliance check

Memory Maintenance

OperationMCP Tool
List memoriesmcp__ccw-tools__core_memory(operation="list")
Search memoriesmcp__ccw-tools__core_memory(operation="search", query="...")
Import memorymcp__ccw-tools__core_memory(operation="import", text="...")
Export memorymcp__ccw-tools__core_memory(operation="export", id="...")

Note: The CLI commands ccw memory * are deprecated. Use MCP tools directly.


Summary

Claude Code Workflow best practices can be summarized as:

  1. Standards First - Establish clear team standards
  2. Process Assurance - Use appropriate workflows
  3. Quality Gatekeeping - Strict code review
  4. Knowledge Accumulation - Continuously maintain Memory and documentation
  5. Continuous Improvement - Regular retrospectives and optimization

Released under the MIT License.