design-record

Generates design documents and decision records as published HTML artifacts with a fixed structure.

1|Updated Aug 6, 2025
One-click install
npx skills add https://github.com/azaidrahman/zaid-sani-dotfiles --skill design-record-azaidrahman
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-record
Source: https://github.com/azaidrahman/zaid-sani-dotfiles/tree/main/dot_claude/skills/design-record
Command: npx skills add https://github.com/azaidrahman/zaid-sani-dotfiles --skill design-record-azaidrahman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Design documents, decision records, and research write-ups often end up with inconsistent structures, making them hard to navigate and compare. This Skill produces every such document in one fixed shape, so readers always find the problem, mechanism, plan, and evidence in the same place. ## Core Features & Use Cases - Fixed document structure: Enforces a reading contract of masthead, problem first, mechanism in the middle, plan last, and an appendix with evidence, limits, and sources. - Evidence strength chips: Marks every claim as measured, narrative, or opinion so build order decisions rest on honest evidence. - Reusable HTML template: Ships a template with sticky index navigation, dark mode, inline SVG figure components, decision blocks, and UI mock components, with only the accent color customizable. - Use Case: After finishing research on a new architecture, ask for a design record and receive a published, navigable HTML artifact with labeled decisions (D-01, D-02), inline SVG diagrams, an evidence table, and a mandatory limits section. ## Quick Start Write up the findings from our caching layer research as a design record and publish it as an artifact.

Frequently Asked Questions about design-record

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

FAQPage Schema
How do I write a design document with a consistent structure?

Use this Skill to generate the document from a fixed HTML template. It enforces a reading contract: problem first, mechanism in the middle, plan last, and an appendix with evidence, limits, and sources, with three to five parts maximum.

What is a decision record and how should decisions be documented?

A decision record captures architectural choices with their rationale. This Skill places each decision in the part it belongs to, giving it an id like D-01, a one-line claim, and a Why line, rather than collecting decisions at the end.

How do I mark evidence strength in a technical document?

Mark every claim with one of three chips: measured for controlled results, narrative for described but unmeasured claims, and opinion for judgement calls. The chips drive build order, so claims must never be overstated.

Can I customize the visual design of the generated document?

Only the accent color may change per subject. The type pairing, layout, spacing, and component classes stay fixed, because consistency across documents is the goal. Figures must be inline SVG, never ASCII diagrams.

When should I not use a design record format?

Do not use it for explaining a code change, reporting bugs from a code review, creating visual mockups or screen designs, or short answers that belong directly in chat. It is meant for design docs, decision records, and research syntheses.