Files
Claude-Code-Workflow/.claude/workflows/cli-templates/protocols/write-protocol.md
2025-12-23 18:49:04 +08:00

4.1 KiB

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

Multi-Task Execution (Resume)

First subtask: Standard execution flow Subsequent subtasks (via resume):

  • Recall context from previous subtasks
  • Build on previous work
  • Maintain consistency
  • Test integration
  • Report context for next subtask

Error Handling

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

Single Task Implementation

# 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]

Multi-Task (First Subtask)

# Subtask 1/N: [TASK Title]

## Changes
[List of file changes]

## Implementation
[Details with code references]

## Testing
✅ Tests: X passing

## Context for Next Subtask
- Key decisions: [established patterns]
- Files created: [paths and purposes]
- Integration points: [where next subtask should connect]

Multi-Task (Subsequent Subtasks)

# Subtask N/M: [TASK Title]

## Changes
[List of file changes]

## Integration Notes
✅ Compatible with previous subtask
✅ Maintains established patterns

## Implementation
[Details with code references]

## Testing
✅ Tests: X passing

## Context for Next Subtask
[If not final, provide context]

Partial Completion

# 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