Index of every page on this site: llms.txt
All skills
Run it yourself

Talks a piece of software work through with the user first - one decision at a time, each with a recommended answer - and only then writes the document together, in plain English anyone can follow. Covers exploring a loose idea into one direction, PRDs, engineering specs, system designs and architecture or scale reviews, information architecture (site maps, navigation, user flows), and documentation such as flows, API references, runbooks, guides and READMEs, with flows drawn on a tldraw canvas or written as Markdown. Use when the user wants to ideate, refine an idea or weigh options, plan or design a feature, asks for a PRD, spec, RFC, design doc, system design, architecture or performance review, site map, navigation or IA, a user flow or flowchart, a runbook, API docs or a README, or says "grill me", "challenge my plan" or "poke holes in this". Not for writing or changing code, visual UI design (use ui-ux-pro-max), or general tldraw canvas edits (use tldraw-offline).

  • 10 files
  • 38.9 KB
  • Updated 3 weeks ago
  • GitHub
Use this Skill: https://skilld.dev/gh/avik-creator/agent-skills/design-docs

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈249 tokens for metadata: the name and description. ≈1.5k when used: this file. ≈8.2k more on demand in 9 files.

Description uses 12.5% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈998 characters, or 12.5%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Design docs

You and the user discuss the work together first. The document comes last, written together from what you both decided. A document handed over before that discussion is one the user didn't shape, and it gets rewritten.

Quick start

  1. Read what already exists (code, routes, docs, configs) before asking anything.
  2. Discuss with the user in chat, one decision at a time, each with your recommended answer. See interview.md, or ideas.md when no direction is chosen yet.
  3. Keep a short running list of what is decided and what is still open, and show it as you go. For every goal, settle how it will be proved, as proof.md says.
  4. Write nothing until the user says the decisions are settled.
  5. Then write the document together: pick the type below, write one section at a time, and check each with the user.
  6. Ask how to deliver the flows (tldraw, Markdown, or both), then where to publish.

Discuss first, write last

  • The discussion is the work. Treat it as you and the user deciding together, not as you collecting inputs to write alone.
  • Don't draft the document, or any part of it, while the discussion is still going. Why: a draft anchors the conversation on what you guessed.
  • Push back when a choice conflicts with an earlier one or with the code. Agreeing to keep things moving leaves the conflict in the document.
  • The document holds only what was decided. If something new appears while writing, stop and discuss it first.
  • If the user only wants the discussion and no document, that is a complete result. End with the decided list and the open questions.

Pick the document (once the discussion is done)

The user wants Read
To explore a loose idea and choose a direction, or an idea brief ideas.md
A PRD (what and why) or an engineering spec (how it will behave) prd-and-spec.md
A system design, an architecture review, or a scale or performance improvement system-design.md
A site map, navigation, page structure, URL rules or user flows for a product information-architecture.md
Docs for something that exists: a flow, API reference, runbook, guide, README, changelog documentation.md
How each goal will be checked, in any plan, PRD or spec proof.md
Any flow or diagram, in any of the above flows-and-diagrams.md
Any draft, before you show it: words and patterns that read as machine-written plain-words.md

If it isn't clear which type, or who will read it, ask. Why: a PRD and a spec for the same feature answer different questions for different readers.

While discussing

  • Look before you ask. Answer from the repo, existing docs, components and configs whenever they can. Why: every question you could have answered yourself costs the user a turn.
  • Never invent a fact: no made-up users, numbers, deadlines, limits or prices. Put the unknown on the open list, and say what it blocks.
  • Before reading a connected source that holds customer or external data, say why you need it and ask.
  • When a decision about logic or how a page looks can't be settled by talking, suggest the prototype skill in one line, and build only after a yes. Why: clicking through real cases settles what argument can't.

Plain English

The reader may be new to the team, non-technical, or reading in their second language.

  • Short sentences, one idea each. Active voice that names who acts: "The server emails a link", not "A link is sent".
  • Define a technical word in the sentence where it first appears. Spell out an abbreviation the first time.
  • When a line could mean two things, add one concrete example.
  • Use one term per concept, everywhere. Why: a reader who sees "workspace" and "project" assumes two different things.
  • Mark every fact as confirmed (cite the file, endpoint or person it came from) or assumed.

Before: "On auth failure the BE 401s and the FE kicks off the refresh flow." After: "If the sign-in token has expired, the server answers 401 (not signed in). The app then asks for a new token and retries once."

Scope

  • Discuss and write documents only. Don't change code, and don't build until the user approves the design. Why: a document is cheap to change, and code built on an unapproved plan is not.
  • A security need is one requirement, or one open question for a security review. Don't invent controls or run an audit; the security skill, where installed, writes the security section with the user.
  • Database detail (schema, indexes, migrations, transactions) follows the database skill where it is installed.
  • Omit any section that would not change a decision. A small change stays a short document.

Deliver and publish

  • Ask each time how to deliver a flow: a tldraw canvas, a plain-English Markdown file, or both. If tldraw isn't available, say how to get it and offer Markdown. See flows-and-diagrams.md.
  • Show the finished document. Then ask where it goes: chat, a Markdown file, or a connected tool (Notion, Confluence, ClickUp and similar). For a file, suggest the repo's existing docs folder, or docs/<feature>/<TYPE>.md when there is none.
  • Write nothing to a file, canvas or tool until the user answers. Why: publishing is hard to take back once others have read it.

Replies

Talk to the user in simple English: short sentences, everyday words, and a technical term only where it is needed, explained the first time it appears.

During the discussion, each reply moves one decision forward and ends with the next question. At the end, say which document you wrote and where, which facts are still assumed, and the open questions with what each one blocks.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at a0324a3. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 days ago.

Activeupdated 3 weeks ago

README badge

README badge for avik-creator/agent-skills/design-docs