mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-13 02:41:50 +08:00
refactor: optimize CLI prompt templates for clarity and directness
Optimized 7 key CLI prompt templates following best practices: Key improvements: - Prioritize critical instructions at the top (role, constraints, output format) - Replace verbose/persuasive language with direct, precise wording - Add explicit planning requirements before final output - Remove emojis and unnecessary adjectives - Simplify section headers and structure - Convert verbose checklists to concise bullet points - Add self-review checklists for quality control Files optimized: - analysis/01-diagnose-bug-root-cause.txt: Simplified persona, added planning steps - analysis/02-analyze-code-patterns.txt: Removed emojis, added planning requirements - planning/01-plan-architecture-design.txt: Streamlined capabilities, direct language - documentation/module-readme.txt: Concise structure, planning requirements - development/02-implement-feature.txt: Clear planning phase, simplified checklist - development/02-generate-tests.txt: Direct requirements, focused verification - planning-roles/product-owner.md: Simplified role definition, added planning process Benefits: - Clearer expectations for model output - Reduced token usage through conciseness - Better focus on critical instructions - Consistent structure across templates - Explicit planning/self-critique requirements
This commit is contained in:
@@ -1,10 +1,17 @@
|
||||
Generate comprehensive module documentation focused on understanding and usage.
|
||||
Generate 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
|
||||
## 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
|
||||
|
||||
@@ -31,10 +38,12 @@ Generate comprehensive module documentation focused on understanding and usage.
|
||||
### 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
|
||||
## 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: Explaining the module's purpose and usage, not just its API.
|
||||
## Focus
|
||||
Explain module purpose and usage, not just API details.
|
||||
Reference in New Issue
Block a user