Playbook

Generate Technical Design Proposal

Start with a built-in AI playbook, customize it as needed, or build your own

AI Agents Involved

Technical WriterSenior DeveloperProduct Manager

Generate a technical design proposal for a given ticket based on the requirements and code context.

Loading workflow...

Workflow Steps

1
repo.identify
Action
Automatically identify the relevant repositories based on the ticket and codebase context
2
git.clone
Action
Clone the relevant repositories for the task to be available for the agents
3
agent.run
Action
Execute a single-agent task for straightforward, non-interactive tasks
Agents
Senior Developer
Instructions

You are a Senior Developer tasked with understanding the requirements in the ticket.

  1. Extract functional & non-functional requirements.
  2. Identify modules or files likely impacted.
  3. List open questions if requirements are ambiguous.

Output a concise JSON block with keys: requirements, impactedAreas, openQuestions.

4
agent.session
Action
Start a multi-agent coordination for complex, interactive task
Agents
Senior DeveloperTechnical Writer
Instructions

You are the Coordinator Agent.
Your responsibility is to orchestrate the creation of a detailed design document.

Process

  1. Delegate the drafting of each required section (Overview, System Impact, Edge Cases, Risks & Mitigations, Open Questions, Next Steps) to the Design Writer sub-agent.
  2. Instruct the sub-agent to:
    • Use insights from the previous analysis step.
    • Access and review the code in the repository to fill in missing details.
    • Embed diagrams when useful, in fenced ```mermaid code blocks.
    • Return results formatted in Markdown.
  3. Collect and assemble the sub-agent outputs into a single cohesive document.
  4. Ensure the final output begins with:
    ```

    Proposed Design

    ```

Constraints

  • Do not reply to the user yet.
  • Do not add results back to the ticket.
  • Only return the completed Markdown document as the final output.
5
agent.session
Action
Start a multi-agent coordination for complex, interactive task
Agents
Product Manager
Instructions

You are the Coordinator Agent.
Your responsibility is to handle the post-processing of the generated design document.

Process

  1. Take the Markdown design content produced in the previous step.
  2. Use add_comment_to_ticket to post it as a comment on the issue.
    • Append the note:

      If you’d like a draft implementation branch, comment /pr.

  3. Use update_ticket to assign the issue to its creator ({{trigger.issue.user.login}}).
  4. Check the "Open Questions" section of the design:
    • If any open questions exist → add the label design-needs-feedback.
    • Otherwise → add the label design-complete.

Constraints

  • Ensure only one final comment is added (idempotent).
  • Do not modify or truncate the generated Markdown content.
  • Always append the /pr note at the end of the comment.

Try Generate Technical Design Proposal now