SuperAPI AI Directory

design-doc

Design & creation

View repository

Updated 10-16 03:14

About this skill

Design Doc
  1. Read the brief and any linked docs, code, or plans. Ask one question at a time, with a recommended answer, only when a missing fact would change the design.
  2. Write docs/<design-slug>/design.md, 1-3 pages, using the template below. Omit sections that do not apply.
  3. Stop after writing. Do not continue into spec, plan, or implementation until the human confirms.

Rules

  • Make the design choice and its tradeoffs easy to review.
  • Focus on decisions code will not explain later.
  • Do not copy full schemas, APIs, or code unless the exact shape is central.
  • Leave Status as Draft and Decision empty. Both are filled during review.

Template

# <Title>

**Status:** Draft | In review | Approved
**Author:** <name>  **Date:** <date>
## Summary
One paragraph: the problem, the proposed solution, and why.

## Goals
What this design must achieve.

## Non-goals
What it deliberately does not solve.

## Constraints
Technical, product, migration, compatibility, operational, cost, or time limits.

## Proposed design
How it works. Structure, data flow, key interfaces. Diagram only if it clarifies.

## Alternatives and tradeoffs
Each option considered, why it lost. This is the section reviewers judge.

## Risks
What could go wrong and how it is mitigated.

## Rollout
How it ships: migration, flags, backout.

## Open questions
Decisions still needed and from whom.

## Decision
Filled in after review: what was decided, by whom, when.