design-doc

Tightens design docs, RFCs, and tech specs while preserving rationale and structure.

Updated Jul 13, 2016
One-click install
npx skills add https://github.com/yang-l/configs --skill design-doc-yang-l
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: design-doc
Source: https://github.com/yang-l/configs/tree/main/.claude/skills/design-doc
Command: npx skills add https://github.com/yang-l/configs --skill design-doc-yang-l

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Design docs, RFCs, and tech specs accumulate bloat: restated decisions, meta-commentary, and inline config dumps that bury the actual reasoning. This Skill trims a document to its one-sentence aim while protecting every distinct rationale, caveat, and justification. ## Core Features & Use Cases - Risk-tiered cutting: Classifies every candidate cut as clean redundancy (apply), framing-only (flag for the author), or rationale-touching (discard), so no "why" is ever lost. - Structure preservation: On published or reviewed docs, uses exact verbatim old-to-new edits with unique-match find/replace and invariant checks so review-comment anchors, intra-doc links, tables, and headings survive the edit. - Detail relocation: Pushes exact values, configs, and tables into an appendix or linked runbook, keeping prose at the what-and-why level. - Use Case: You have a 12-page architecture proposal with reviewer comments anchored throughout. Ask the Skill to tighten it for final review; it cuts restatement and boilerplate, moves config tables to an appendix, and leaves every comment anchor intact. ## Quick Start Tighten this design doc for review, keep all the rationale, and don't break any of the existing comment anchors or section links.

Frequently Asked Questions about design-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I shorten a design doc without losing the reasoning?▼

State the doc's aim in one sentence, then cut only restatement and meta-commentary while keeping every distinct rationale, caveat, and justification. Tier each candidate cut by risk: clean redundancy is applied, framing-only changes are flagged, and anything touching rationale is discarded.

How to edit a reviewed doc without breaking review comments?▼

Use exact verbatim old-to-new edits with unique-match find/replace plus an invariant and structure check instead of freehand rewriting. This keeps headings, anchors, intra-doc links, code blocks, and tables stable so reviewer comments stay attached.

Can this Skill trim runbooks or step-by-step guides?▼

No. Runbooks and how-to guides are explicitly out of scope because they carry procedure rather than design rationale. The Skill links out to runbooks for the how while the design doc keeps the what and why.

What kinds of documents does design-doc editing support?▼

It supports design docs, RFCs, tech specs, architecture proposals, one-pagers, and design proposals. It skips general prose, marketing copy, and procedural guides that contain no design rationale.

What happens if my design doc is already tight?▼

The Skill says so and stops rather than inventing churn. Its rules require honesty about the ceiling: if no safe cuts remain, no edits are made.