tech-review-doc
Installation
SKILL.md
Technical Design → Technical Review Document
Convert a code-heavy design document into a technical review document for product, QA, and engineers who are not deep in the code.
Core principles
| Principle | Requirement |
|---|---|
| Audience | Non-code-deep readers can understand §§1–4 on their own |
| Language | Concise and plain; §§1–3 zero code; from §4 onward keep only necessary interface/field/table purpose |
| Diagrams | Mermaid; nodes use business/module names, not class or file names |
| Source of truth | The design doc is factual; user-confirmed content overrides vague design wording |
| Brevity | For each section ask: “Does anyone in the review meeting need this?” — if not, omit it |
| Template | Use sibling template.md |