synthesis-code-planning

Code Planning

A structured methodology for approaching code tasks that produces higher-quality implementations by evaluating multiple approaches before committing to one.

Inputs

Before generating code, gather three inputs:

1. Task description -- what needs to be built or changed
2. Existing code -- the current codebase or relevant files (if any)
3. Contextual documentation -- relevant API docs, framework guides, coding standards, or architectural decisions

Process

Step 1: Analyze

Carefully analyze the task description and existing code. Consider:

• What is the actual goal (not just the literal request)?
• What constraints does the existing code impose?
• What are the performance, maintainability, and correctness requirements?
• What best practices apply to this language, framework, or domain?

Step 2: Generate approaches

Produce at least two distinct approaches to address the task. For each approach, document:

Approach 1: [Brief description]

• Pros:
  • [Advantage 1]
  • [Advantage 2]
• Cons:
  • [Drawback 1]
  • [Drawback 2]

Approach 2: [Brief description]

• Pros:
  • [Advantage 1]
  • [Advantage 2]
• Cons:
  • [Drawback 1]
  • [Drawback 2]

Generate more approaches when the problem space is ambiguous or when the first two approaches have significant trade-offs against each other.

Step 3: Evaluate and select

Select the optimal solution and justify the choice with specific reasoning:

• Reference the pros and cons of each approach
• Explain why the chosen approach best addresses the task requirements
• Acknowledge what is sacrificed by not choosing the alternatives
• If the decision is close, state that explicitly

Step 4: Implement

Implement the chosen solution by modifying or creating code:

• Mark changes clearly when modifying existing code
• Follow the conventions and patterns already present in the codebase
• Optimize for performance, maintainability, and adherence to best practices
• Include necessary error handling and edge case coverage