agentleFS
prestariusprestarius/jet-skills-stack/skills/design-doc/SKILL.md

design-doc

Skill1 starsChanged 2 months agoMITView on GitHub

Author a design document (RFC) for a feature or system before the decision is locked — problem, requirements, options, proposed design, risks. Use whenever the user says "write a design doc", "draft an RFC", "write up the design", "proposal for the team", or has finished discussing an approach and needs the document that carries it to reviewers. Upstream of domain-modeling (the ADR) and to-spec (the implementation spec).

25 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use testing, commit and 1 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • NVIDIASkill

    testing

    Run Python and Rust tests for physicsnemo-curator using uv + pytest with coverage reporting via pytest-cov, and cargo-nextest for Rust tests. Includes benchmark workflows with pytest-benchmark and criterion.

    Also in 3 projects that use this

  • SentrySkill

    commit

    Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.

    Also in 4 projects that use this

  • GoogleSkill

    grill-me

    A relentless interview to sharpen a plan or design.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 21 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Write ONE Markdown design document a reviewer can evaluate without having been in the discussion.

    line 8
  2. Very specific:

    Read ./CONTEXT.md first — stack, domain language, constraints come from there, not assumptions.

    line 9

“Common” is measured: kept by at least 6 in 10 of the 21 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Write ONE Markdown design document a reviewer can evaluate without having been in the discussion. Read ./CONTEXT.md first — stack, domain language, constraints come from there, not assumptions.

Sections, in order:

  1. Problem & context — what hurts today and why now. Neutral; no solution yet.
  2. Goals / non-goals — what this design must achieve; what is explicitly out of scope.
  3. Requirements & constraints — functional and non-functional (scale, latency, budget, compliance per CONTEXT.md), each marked hard or soft.
  4. Current state — the relevant existing architecture, in the project's own terms.
  5. Proposed design — the recommended approach, concrete enough to challenge: components, boundaries, data flow, sync/async choices. Bias to the simplest design that meets the requirements; say what was deliberately left simple.
  6. Options considered — the real alternatives via the tradeoff-table skill, plus the one-line reason each lost. A design doc with no rejected options is incomplete.
  7. Risks & open questions — what could invalidate the design; what reviewers must decide.

Style: decisive, terse, no hedging; diagrams (Mermaid) where they remove ambiguity. If something load-bearing is genuinely unknown, ask one sharp question before writing rather than inventing it.

Downstream: once the design is accepted, capture the decision with the domain-modeling skill; to hand the build to an agent, use to-spec; to hand it to a team, use to-tickets.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.