mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-11 02:33:51 +08:00
f14418603a
重构 ccw cli 模板系统： - 新增 template-discovery.ts 模块，支持扁平化模板自动发现 - 添加 --rule <template> 选项，自动加载 protocol 和 template - 模板目录从嵌套结构 (prompts/category/file.txt) 迁移到扁平结构 (prompts/category-function.txt) - 更新所有 agent/command 文件，使用 $PROTO $TMPL 环境变量替代 $(cat ...) 模式 - 支持模糊匹配：--rule 02-review-architecture 可匹配 analysis-review-architecture.txt 其他更新： - Dashboard: 添加 Claude Manager 和 Issue Manager 页面 - Codex-lens: 增强 chain_search 和 clustering 模块 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
49 lines
1.4 KiB
Plaintext
49 lines
1.4 KiB
Plaintext
Generate module documentation focused on understanding and usage.
|
|
|
|
## Planning Required
|
|
Before providing documentation, you MUST:
|
|
1. Understand what the module does and why it exists
|
|
2. Review existing documentation to avoid duplication
|
|
3. Prepare practical usage examples
|
|
4. Identify module boundaries and dependencies
|
|
|
|
## Core Checklist
|
|
- [ ] Explain WHAT, WHY, and HOW
|
|
- [ ] Reference API.md instead of duplicating signatures
|
|
- [ ] Include practical usage examples
|
|
- [ ] Define module 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
|
|
Before finalizing output, verify:
|
|
- [ ] Module purpose, scope, and boundaries are clear
|
|
- [ ] Core concepts are explained
|
|
- [ ] Usage examples are practical and realistic
|
|
- [ ] Dependencies and configuration are documented
|
|
|
|
## Focus
|
|
Explain module purpose and usage, not just API details. |