design-docs

Generates and syncs language-agnostic design documentation with stable section IDs and traceability.

Updated Sep 14, 2026
One-click install
npx skills add https://github.com/pandejesal/drone-nav-sar --skill design-docs-pandejesal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-docs
Source: https://github.com/pandejesal/drone-nav-sar/tree/main/.swarm/bundled-skills/design-docs
Command: npx skills add https://github.com/pandejesal/drone-nav-sar --skill design-docs-pandejesal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping design documentation consistent with evolving code and specs is tedious and error-prone. This Skill automates the generation and synchronization of structured, language-agnostic design docs (domain.md, technical-spec.md, behavior-spec.md) so documentation never drifts from the authoritative spec. ## Core Features & Use Cases - Structured Doc Generation: Creates a fixed set of design docs (domain, technical-spec, behavior-spec, design-changelog, reference/) with stable section IDs (D-###, S-###, B-###, R-###) that are never renumbered. - Spec Traceability: Maintains a machine-readable traceability.json registry mapping every doc section to spec FR IDs, invariants, and code anchors, plus a human-readable mirror table. - Sync Mode: Updates only affected sections when code or specs change, preserving existing IDs and appending entries to a design changelog. - Use Case: After completing a development phase, trigger a sync so the design docs reflect the latest diff, with drift detection flagging stale sections automatically. ## Quick Start Ask the architect to run the design-docs command to generate fresh design documentation for the project from the current spec.

Frequently Asked Questions about design-docs

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

FAQPage Schema
How do I generate design documentation from a spec automatically?

Trigger the design-docs command, which dispatches a docs_design agent to author domain.md, technical-spec.md, and behavior-spec.md from the authoritative spec file. Each section receives a stable ID and a traceability footer linking back to spec FR identifiers.

How do I keep design docs in sync with code changes?

Run the skill in sync mode with the list of changed files and a changes summary. It updates only affected sections, reuses all existing section IDs, and appends an entry to design-changelog.md under the Unreleased heading.

What files does the design-docs workflow create?

It creates domain.md, technical-spec.md, behavior-spec.md, design-changelog.md, and a reference/ directory containing reference-impl.md, idiom-notes.md, and traceability.json. It creates nothing else and never modifies source code or release changelogs.

Why are framework names not allowed in design documentation?

The skill enforces language-agnostic normative text so design docs survive technology migrations. All framework, library, and language-specific material is isolated in the reference/ directory, keeping domain and behavior specs portable.

What happens when design docs drift from the code?

A deterministic drift check writes a doc-drift report during phase wrap. If the verdict is DOC_STALE, the skill dispatches a sync for affected sections only; this is advisory and never blocks phase completion.