skills.rest
truongnat
truongnatCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

detail-design

Generates implementable design specifications with contracts, data models, and sequences from a basic design document.

Updated Jul 28, 2026
Search Tags:#api contracts#design documentation#data model#sequence diagram#planning handoff#detail design#doc reality check
One-click install
npx skills add https://github.com/truongnat/Restly --skill detail-design-truongnat
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: detail-design
Source: https://github.com/truongnat/Restly/tree/main/.agents/skills/detail-design
Command: npx skills add https://github.com/truongnat/Restly --skill detail-design-truongnat

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often jump from a rough basic design straight into coding, which leads to invented schemas, undocumented assumptions, and mismatches between documentation and actual code. This Skill turns an approved BASIC_DESIGN.md into a precise, implementable DETAIL_DESIGN.md that planning can consume safely. ## Core Features & Use Cases - Doc reality check: Re-verifies documentation claims against actual code before writing contracts, and stops to ask the user when blocking mismatches appear. - Structured design artifacts: Produces contracts (HTTP/RPC/events/CLI), data models with known/inferred confidence labels, sequences for happy and error paths, validation rules, operations, and optional client mapping. - Assumption and gap tracking: Records assumptions with confirmation status and lists gaps instead of inventing missing details, then hands off explicitly to planning. - Use Case: After agreeing on feature boundaries in BASIC_DESIGN.md, run this Skill to produce a DETAIL_DESIGN.md with verified API contracts, a confidence-labeled data model, Mermaid sequence diagrams, and a clean handoff to the planning stage. ## Quick Start Use the detail-design skill to turn my BASIC_DESIGN.md into a DETAIL_DESIGN.md with verified contracts, data model, and sequences before planning.

Frequently Asked Questions about detail-design

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

FAQPage Schema
How do I create a detailed design document from a basic design?▼

Provide an approved BASIC_DESIGN.md and run this Skill. It re-verifies documentation against the actual code, then produces a DETAIL_DESIGN.md with contracts, data models, sequences, rules, and a handoff to planning.

What is a doc reality check in software design?▼

A doc reality check compares claims in design documents and wiki pages against the actual codebase before writing contracts. Existing handlers or schemas are marked known, new surfaces are marked proposed, and blocking mismatches require user confirmation before proceeding.

When should I not use a detail design skill?▼

Skip it when BASIC_DESIGN.md is missing or blocked, when business requirements are unresolved, or when the task is small and clear enough to go straight to planning or execution. It also never writes code or creates task IDs.

Can detail design handle APIs without a UI?▼

Yes. Sections are dynamic: client mapping is omitted when no UI is in scope, and data model or persistence sections are omitted when nothing is stored. Only applicable sections like contracts, operations, and error handling are included.

What happens when documentation contradicts the code?▼

The mismatch is flagged as Blocking, and the Skill stops to ask the user which source is authoritative before filling contracts or the data model. Inferred fields stay labeled inferred until confirmed by the user.

Related Skills

Explore More Software Engineering Skills→
monkeypantsmonkeypants

bmc-research

Generate initial hypotheses for all nine Business Model Canvas blocks.

Community
Intermediate
mo7amedElfadilmo7amedElfadil

maintaining-planning

Orchestrate multi-step tasks into atomic RED/GREEN/REFACTOR actions with verification commands.

Community
Advanced
linenoizelinenoize
1

docs

Generate and maintain project documentation from code and git history.

Community
Advanced
HonigbartHonigbart
1

quick-plan

Write executable plans to .ai/plans/<slug>/final_plan.md.

Community
Basic