mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-13 02:41:50 +08:00
a944e31962
- Introduced new analysis templates for architecture, implementation patterns, performance, quality, and security. - Created detailed development templates for component creation, debugging, feature implementation, refactoring, testing, and migration planning. - Established structured documentation guidelines for root, domain, module, and sub-module levels to enhance clarity and organization. - Implemented a hierarchy analysis template to optimize project structure and documentation depth. - Updated codex-unified documentation to reflect new command structures, template usage, and best practices for autonomous development workflows.
69 lines
2.1 KiB
Plaintext
69 lines
2.1 KiB
Plaintext
Create or update sub-module-level CLAUDE.md documentation:
|
|
|
|
## Layer 4: Sub-Module Level Documentation Requirements
|
|
|
|
### Content Focus (MUST INCLUDE):
|
|
1. **Detailed Implementation Specifics**
|
|
- Specific implementation details and algorithms
|
|
- Code-level patterns and idioms
|
|
- Implementation trade-offs and decisions
|
|
|
|
2. **Component/Function Documentation**
|
|
- Individual component descriptions
|
|
- Function signatures and behaviors
|
|
- Class/struct/interface documentation
|
|
|
|
3. **Configuration Details and Examples**
|
|
- Configuration options and parameters
|
|
- Environment-specific settings
|
|
- Configuration examples and templates
|
|
|
|
4. **Usage Examples and Patterns**
|
|
- Code examples and usage patterns
|
|
- Common use cases and scenarios
|
|
- Integration examples with other components
|
|
|
|
5. **Performance Considerations**
|
|
- Performance characteristics and constraints
|
|
- Optimization strategies and techniques
|
|
- Resource usage and scalability notes
|
|
|
|
### Content Restrictions (STRICTLY AVOID):
|
|
- Architecture decisions (belong in higher levels)
|
|
- Module-level organizational patterns (belong in module-level docs)
|
|
- Domain or project overview content (belong in higher levels)
|
|
- Cross-module architectural concerns (belong in higher levels)
|
|
|
|
### Documentation Style:
|
|
- Focus on detailed, actionable implementation information
|
|
- Provide concrete examples and code snippets
|
|
- Document specific behaviors and edge cases
|
|
- Include troubleshooting and debugging guidance
|
|
|
|
### Template Structure:
|
|
```markdown
|
|
# [Sub-Module/Component Name] - Implementation Guide
|
|
|
|
## 1. Component Overview
|
|
[Specific purpose and functionality]
|
|
|
|
## 2. Implementation Details
|
|
[Detailed implementation specifics]
|
|
|
|
## 3. API Reference
|
|
[Function/method documentation]
|
|
|
|
## 4. Configuration
|
|
[Configuration options and examples]
|
|
|
|
## 5. Usage Examples
|
|
[Code examples and patterns]
|
|
|
|
## 6. Performance and Optimization
|
|
[Performance considerations and tips]
|
|
|
|
## 7. Troubleshooting
|
|
[Common issues and solutions]
|
|
```
|
|
|
|
Remember: This is Layer 4 - focus on concrete, actionable implementation details and avoid architectural or organizational concerns. |