mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-10 02:24:35 +08:00
Refactor code structure for improved readability and maintainability
This commit is contained in:
catlog22
119
.ccw/workflows/cli-templates/protocols/analysis-protocol.md
Normal file
119
.ccw/workflows/cli-templates/protocols/analysis-protocol.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# Analysis Mode Protocol
|
||||
|
||||
## Mode Definition
|
||||
**Mode**: `analysis` (READ-ONLY)
|
||||
## Prompt Structure
|
||||
|
||||
```
|
||||
PURPOSE: [development goal]
|
||||
TASK: [specific implementation task]
|
||||
MODE: [auto|write]
|
||||
CONTEXT: [file patterns]
|
||||
EXPECTED: [deliverables]
|
||||
RULES: [templates | additional constraints]
|
||||
```
|
||||
## Operation Boundaries
|
||||
|
||||
### ALLOWED Operations
|
||||
- **READ**: All CONTEXT files and analyze content
|
||||
- **ANALYZE**: Code patterns, architecture, dependencies
|
||||
- **GENERATE**: Text output, insights, recommendations
|
||||
- **DOCUMENT**: Analysis results in output response only
|
||||
|
||||
### FORBIDDEN Operations
|
||||
- **NO FILE CREATION**: Cannot create any files on disk
|
||||
- **NO FILE MODIFICATION**: Cannot modify existing files
|
||||
- **NO FILE DELETION**: Cannot delete any files
|
||||
- **NO DIRECTORY OPERATIONS**: Cannot create/modify directories
|
||||
|
||||
**CRITICAL**: Absolutely NO file system operations - OUTPUT ONLY
|
||||
|
||||
## Execution Flow
|
||||
|
||||
1. **Parse** all 6 fields (PURPOSE, TASK, MODE, CONTEXT, EXPECTED, RULES)
|
||||
2. **Read** and analyze CONTEXT files thoroughly
|
||||
3. **Identify** patterns, issues, and dependencies
|
||||
4. **Generate** insights and recommendations
|
||||
5. **Validate** EXPECTED deliverables met
|
||||
6. **Output** structured analysis (text response only)
|
||||
|
||||
## Core Requirements
|
||||
|
||||
**ALWAYS**:
|
||||
- Analyze ALL CONTEXT files completely
|
||||
- Apply RULES (templates + constraints) exactly
|
||||
- Provide code evidence with `file:line` references
|
||||
- List all related/analyzed files at output beginning
|
||||
- Match EXPECTED deliverables precisely
|
||||
|
||||
**NEVER**:
|
||||
- Assume behavior without code verification
|
||||
- Ignore CONTEXT file patterns
|
||||
- Skip RULES or templates
|
||||
- Make unsubstantiated claims
|
||||
- Create/modify/delete any files
|
||||
|
||||
## RULES Processing
|
||||
|
||||
- Parse RULES field to extract template content and constraints
|
||||
- Recognize `|` as separator: `template content | additional constraints`
|
||||
- Apply ALL template guidelines as mandatory
|
||||
- Treat rule violations as task failures
|
||||
|
||||
## Error Handling
|
||||
|
||||
**File Not Found**: Report missing files, continue with available, note in output
|
||||
**Invalid CONTEXT Pattern**: Report invalid pattern, request correction, do not guess
|
||||
|
||||
## Quality Standards
|
||||
|
||||
- **Thoroughness**: Analyze ALL files, check cross-file patterns, quantify metrics
|
||||
- **Evidence-Based**: Quote code with `file:line`, link patterns, support claims with examples
|
||||
- **Actionable**: Clear recommendations, prioritized by impact, incremental changes
|
||||
|
||||
---
|
||||
|
||||
## Output Format
|
||||
|
||||
### Format Priority
|
||||
|
||||
**If template defines output format** → Follow template format EXACTLY
|
||||
|
||||
**If template has no format** → Use default format below
|
||||
|
||||
### Default Analysis Output
|
||||
|
||||
```markdown
|
||||
# Analysis: [TASK Title]
|
||||
|
||||
## Related Files
|
||||
- `path/to/file1.ext` - [Brief description of relevance]
|
||||
- `path/to/file2.ext` - [Brief description of relevance]
|
||||
|
||||
## Summary
|
||||
[2-3 sentence overview]
|
||||
|
||||
## Key Findings
|
||||
1. [Finding] - path/to/file:123
|
||||
2. [Finding] - path/to/file:456
|
||||
|
||||
## Detailed Analysis
|
||||
[Evidence-based analysis with code quotes]
|
||||
|
||||
## Recommendations
|
||||
1. [Actionable recommendation]
|
||||
2. [Actionable recommendation]
|
||||
```
|
||||
|
||||
### Code References
|
||||
|
||||
**Format**: `path/to/file:line_number`
|
||||
**Example**: `src/auth/jwt.ts:45` - Authentication uses deprecated algorithm
|
||||
|
||||
### Quality Checklist
|
||||
|
||||
- [ ] All CONTEXT files analyzed
|
||||
- [ ] Code evidence with `file:line` references
|
||||
- [ ] Specific, actionable recommendations
|
||||
- [ ] No unsubstantiated claims
|
||||
- [ ] EXPECTED deliverables met
|
||||
136
.ccw/workflows/cli-templates/protocols/write-protocol.md
Normal file
136
.ccw/workflows/cli-templates/protocols/write-protocol.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# Write Mode Protocol
|
||||
## Prompt Structure
|
||||
|
||||
```
|
||||
PURPOSE: [development goal]
|
||||
TASK: [specific implementation task]
|
||||
MODE: [auto|write]
|
||||
CONTEXT: [file patterns]
|
||||
EXPECTED: [deliverables]
|
||||
RULES: [templates | additional constraints]
|
||||
```
|
||||
## Operation Boundaries
|
||||
|
||||
### MODE: write
|
||||
- **READ**: All CONTEXT files and analyze content
|
||||
- **CREATE**: New files (documentation, code, configuration)
|
||||
- **MODIFY**: Existing files (update content, refactor code)
|
||||
- **DELETE**: Files when explicitly required
|
||||
|
||||
**Restrictions**: Follow project conventions, cannot break existing functionality
|
||||
|
||||
**Constraint**: Must test every change
|
||||
|
||||
## Execution Flow
|
||||
|
||||
### MODE: write
|
||||
1. **Parse** all 6 fields (PURPOSE, TASK, MODE, CONTEXT, EXPECTED, RULES)
|
||||
2. **Read** CONTEXT files, find 3+ similar patterns
|
||||
3. **Plan** implementation following RULES
|
||||
4. **Execute** requested file operations
|
||||
5. **Validate** changes
|
||||
6. **Report** file changes
|
||||
|
||||
## Core Requirements
|
||||
|
||||
**ALWAYS**:
|
||||
- Study CONTEXT files - find 3+ similar patterns before implementing
|
||||
- Apply RULES exactly
|
||||
- Test continuously (auto mode)
|
||||
- Commit incrementally (auto mode)
|
||||
- Match project style exactly
|
||||
- List all created/modified files at output beginning
|
||||
|
||||
**NEVER**:
|
||||
- Make assumptions without code verification
|
||||
- Ignore existing patterns
|
||||
- Skip tests (auto mode)
|
||||
- Use clever tricks over boring solutions
|
||||
- Break backward compatibility
|
||||
- Exceed 3 failed attempts without stopping
|
||||
|
||||
|
||||
**Three-Attempt Rule**: On 3rd failure, stop and report what attempted, what failed, root cause
|
||||
|
||||
| Error Type | Response |
|
||||
|------------|----------|
|
||||
| Syntax/Type | Review → Fix → Re-run tests |
|
||||
| Runtime | Analyze stack → Add handling → Test |
|
||||
| Test Failure | Debug → Review setup → Fix |
|
||||
| Build Failure | Check messages → Fix incrementally |
|
||||
|
||||
---
|
||||
|
||||
## Output Format
|
||||
|
||||
### Format Priority
|
||||
|
||||
**If template defines output format** → Follow template format EXACTLY
|
||||
|
||||
**If template has no format** → Use default format below
|
||||
|
||||
### Task Implementation
|
||||
|
||||
```markdown
|
||||
# Implementation: [TASK Title]
|
||||
|
||||
## Changes
|
||||
- Created: `path/to/file1.ext` (X lines)
|
||||
- Modified: `path/to/file2.ext` (+Y/-Z lines)
|
||||
- Deleted: `path/to/file3.ext`
|
||||
|
||||
## Summary
|
||||
[2-3 sentence overview]
|
||||
|
||||
## Key Decisions
|
||||
1. [Decision] - Rationale and reference to similar pattern
|
||||
2. [Decision] - path/to/reference:line
|
||||
|
||||
## Implementation Details
|
||||
[Evidence-based description with code references]
|
||||
|
||||
## Testing
|
||||
- Tests written: X new tests
|
||||
- Tests passing: Y/Z tests
|
||||
|
||||
## Validation
|
||||
✅ Tests: X passing
|
||||
✅ Build: Success
|
||||
|
||||
## Next Steps
|
||||
[Recommendations if any]
|
||||
```
|
||||
|
||||
### Partial Completion
|
||||
|
||||
```markdown
|
||||
# Task Status: Partially Completed
|
||||
|
||||
## Completed
|
||||
- [What worked]
|
||||
- Files: `path/to/completed.ext`
|
||||
|
||||
## Blocked
|
||||
- **Issue**: [What failed]
|
||||
- **Root Cause**: [Analysis]
|
||||
- **Attempted**: [Solutions tried - attempt X of 3]
|
||||
|
||||
## Required
|
||||
[What's needed to proceed]
|
||||
|
||||
## Recommendation
|
||||
[Suggested next steps]
|
||||
```
|
||||
|
||||
### Code References
|
||||
|
||||
**Format**: `path/to/file:line_number`
|
||||
**Example**: `src/auth/jwt.ts:45` - Implemented following pattern from `src/auth/session.ts:78`
|
||||
|
||||
### Quality Checklist
|
||||
|
||||
- [ ] All tests pass
|
||||
- [ ] Build succeeds
|
||||
- [ ] All EXPECTED deliverables met
|
||||
- [ ] Code follows existing patterns
|
||||
- [ ] File changes listed at beginning
|
||||
Reference in New Issue
Block a user