mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-13 02:41:50 +08:00
39a35c24b1
- Streamlined analysis templates (architecture, pattern, performance, quality, security) - Simplified development templates (component, debugging, feature, refactor, testing) - Optimized documentation templates (api, folder-navigation, module-readme, project-architecture, project-examples, project-readme) - Enhanced planning templates (concept-eval, migration, task-breakdown) - Improved verification templates (codex-technical, cross-validation, gemini-strategic) - Updated claude-module-unified memory template - Refined workflow-architecture documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
40 lines
1.3 KiB
Plaintext
40 lines
1.3 KiB
Plaintext
Generate comprehensive module documentation focused on understanding and usage.
|
|
|
|
## CORE CHECKLIST ⚡
|
|
□ Explain WHAT the module does, WHY it exists, and HOW to use it
|
|
□ Do NOT duplicate API signatures from API.md; refer to it instead
|
|
□ Provide practical, real-world usage examples
|
|
□ Clearly define the module's boundaries and dependencies
|
|
|
|
## DOCUMENTATION STRUCTURE
|
|
|
|
### 1. Purpose
|
|
- **What**: Clearly state what this module is responsible for.
|
|
- **Why**: Explain the problem it solves.
|
|
- **Boundaries**: Define what is in and out of scope.
|
|
|
|
### 2. Core Concepts
|
|
- Explain key concepts, patterns, or abstractions.
|
|
|
|
### 3. Usage Scenarios
|
|
- Provide 2-4 common use cases with code examples.
|
|
|
|
### 4. Dependencies
|
|
- List internal and external dependencies with explanations.
|
|
|
|
### 5. Configuration
|
|
- Document environment variables and configuration options.
|
|
|
|
### 6. Testing
|
|
- Explain how to run tests for the module.
|
|
|
|
### 7. Common Issues
|
|
- List common problems and their solutions.
|
|
|
|
## VERIFICATION CHECKLIST ✓
|
|
□ The module's purpose, scope, and boundaries are clearly defined
|
|
□ Core concepts are explained for better understanding
|
|
□ Usage examples are practical and demonstrate real-world scenarios
|
|
□ All dependencies and configuration options are documented
|
|
|
|
Focus: Explaining the module's purpose and usage, not just its API. |