skills.rest
devbasex
devbasexOFFICIAL
Explore all skills by this author →
GitHub

design

Write software design documents covering data structures, interface contracts, and decisions before coding.

1|Updated Apr 21, 2026
Search Tags:#documentation#decision record#software architecture#design document#design review#er diagram#api contract
One-click install
npx skills add https://github.com/devbasex/ai-plugins --skill design-devbasex
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: design
Source: https://github.com/devbasex/ai-plugins/tree/main/plugins/ndf/skills/design
Command: npx skills add https://github.com/devbasex/ai-plugins --skill design-devbasex

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Starting implementation without a documented design leads to inconsistent deliverables, rework when design errors surface late, and lost rationale for architectural choices. This Skill standardizes what a design document must contain so any engineer or AI agent produces the same structure. ## Core Features & Use Cases - Mode-based deliverables: Defines which artifacts (class diagrams, ER diagrams, API specs, non-functional design tables) are required per workflow mode (light, operation, legacy-refactor, standard) and per touched area. - Structured design template: Provides a document template with sections for components, structure, data, interface contracts, decisions, and test design, each mapped to downstream implementation tasks. - Design review workflow: Guides issuing a design Pull Request before implementation for standard-mode changes, including internal consistency checks across document sections. - Use Case: When adding a new API with persistent storage, use this Skill to produce an ER diagram, table definitions, an OpenAPI contract, and a decision record before writing any code. ## Quick Start Use the design skill to write the design document for this change, covering the data structures, interface contracts, and key decisions.

Frequently Asked Questions about design

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

FAQPage Schema
How do I write a software design document before coding?▼

Identify the touched areas (structure, data, API, UI, non-functional), then fill the design template sections that apply: component diagrams, class diagrams, ER diagrams, interface contracts, and a decision record. Each section maps directly to implementation tasks.

What should a design document include for API changes?▼

API changes require a machine-readable OpenAPI specification stored as a separate file, plus design document entries covering changed routes, compatibility impact on existing callers, and the command used to validate the specification.

When is a design document not required?▼

In light and operation modes, no standalone design document is created; design notes go into the specification or execution record instead. A full design document with a design pull request is mandatory only in standard mode.

How do I document architecture decisions in a design doc?▼

Record each decision as a subsection with the conclusion first, followed by the reasoning and rejected alternatives. Only log choices where multiple options existed; skip decisions that merely followed existing conventions.

What diagrams should a software design document contain?▼

Include only diagrams matching the change: class diagrams for type changes, ER diagrams and table definitions for schema changes, sequence or state diagrams for behavior changes, and context/component/deployment diagrams for architectural changes.

Related Skills

Explore More Software Engineering Skills→
MileniumTickMileniumTick

sdd-spec

Write delta specs with Given/When/Then scenarios and ADDED/MODIFIED/REMOVED blocks.

Community
Intermediate
korwlik23korwlik23

writing-plans

Generate an executable implementation plan with ordered, verifiable tasks.

Community
Intermediate
EveryIncEveryInc
24.7k

ce-doc-review

Reviews requirements and plan documents with role-specific reviewer personas and synthesized findings.

Official
Advanced
XGanQAQXGanQAQ
1

quick-design

Classify small gameplay changes and draft Quick Design Specs.

Community
Intermediate