design-define

Creates capability-organized technical documentation for data models, API groups, flows, and diagrams.

Updated May 8, 2026
One-click install
npx skills add https://github.com/juanca202/sdd-devkit --skill design-define-juanca202
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: design-define
Source: https://github.com/juanca202/sdd-devkit/tree/main/skills/design-define
Command: npx skills add https://github.com/juanca202/sdd-devkit --skill design-define-juanca202

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve? Technical specifications for models, API endpoints, flows, and architecture diagrams often end up scattered, inconsistent, or missing entirely, leaving implementers to guess. This Skill produces structured, per-capability technical documentation in docs/architecture/ with stable identifiers (MD-XXX, API-XXX, FL-XXX, DG-XXX) that user stories, technical tasks, and maintenance tasks can reference as implementation sources. ## Core Features & Use Cases - Capability-based organization: Each capability gets a folder with an index README plus models/, apis/, flows/, and diagrams/ subfolders, one file per element with stable sequential IDs. - Grouped API contracts: Endpoints are grouped by entity or functionality (e.g., full CRUD of a resource in one API-XXX file), each operation carrying an explicit method+route anchor for precise cross-referencing. - Structured gap grilling: Before writing, the Skill asks targeted questions about missing types, error codes, flow branches, and auth rules, logging unresolved gaps in Observations instead of inventing data. - Delegated mode: Other skills (work-define, work-plan) can invoke it via subagent to produce technical specs and receive ready-to-insert file references. - Use Case: While defining a user story for credit notes, the Skill creates MD-003 (credit note model) and API-002 (credit notes endpoint group) under docs/architecture/facturacion/ and returns the references for the story's References section. ## Quick Start Ask the agent to document the data model and API endpoints for the invoicing capability using the design-define skill.

Frequently Asked Questions about design-define

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

FAQPage Schema
How do I document API endpoints for a software capability?▼

Group endpoints by entity or functionality into a single API-XXX file under docs/architecture/[capability]/apis/, with each operation getting an explicit anchor derived from method and route. The capability README indexes every group, and user stories or tasks reference the file path plus anchor.

How to structure technical documentation for user stories?▼

Organize docs by capability, not by story: one folder per capability containing models/, apis/, flows/, and diagrams/ subfolders with one file per element. Stories reference elements by stable IDs like MD-001 or API-002, so multiple stories can consume the same specification.

Should each API endpoint get its own documentation file?▼

No. Endpoints of the same entity or functionality belong in one grouped file, such as a full CRUD for projects in API-001-proyectos.md. Individual operations are cited via method+route anchors like #post-projects, keeping references stable across renames and version bumps.

What happens when technical details are missing during documentation?▼

The Skill asks targeted questions about gaps like missing field types, undefined error codes, or ambiguous flow branches. If no answers are available, gaps are recorded in the Observations section citing the affected element rather than inventing plausible values.

Can this skill create architecture decision records or wireframes?▼

No. ADRs live in docs/adr/ and are never created by this skill, and wireframes (WF-XXX) are produced by requirement-refine or work-define. This skill only reads wireframes as UI context and preserves their index rows when updating the capability README.