design-docs

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

Updated Mar 30, 2026
One-click install
npx skills add https://github.com/ZaxbyHub/ragappv3 --skill design-docs-zaxbyhub
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: design-docs
Source: https://github.com/ZaxbyHub/ragappv3/tree/main/.opencode/skills/design-docs
Command: npx skills add https://github.com/ZaxbyHub/ragappv3 --skill design-docs-zaxbyhub

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 so architecture, behavior, and domain knowledge stay current and traceable to requirements. ## Core Features & Use Cases - Structured Doc Generation: Creates domain.md, technical-spec.md, behavior-spec.md, a design changelog, and a reference/ directory with language-specific material kept strictly separate from normative text. - Stable Section-ID Registry: Assigns permanent D-###, S-###, B-###, and R-### section IDs tracked in traceability.json, so sections are never renumbered across regenerations. - Spec Traceability: Every section carries a traceability footer linking to FR-### requirement IDs from the project spec, plus a human-readable mirror table in technical-spec.md. - Use Case: After a development phase changes several modules, run the sync mode to update only the affected design-doc sections, append a design-changelog entry, and keep docs aligned with the current spec without touching source code. ## Quick Start Ask the architect to run the design-docs mode with a system description, for example: generate design docs for the document ingestion pipeline into the docs directory.

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 project spec?▼

Dispatch the design-docs mode with a system description and output directory. The docs_design agent reads the spec as the authoritative requirements source and generates domain.md, technical-spec.md, behavior-spec.md, and a reference/ directory with traceable section IDs.

How do I keep design docs in sync after code changes?▼

Run the mode with update set to true. The agent loads the existing traceability.json registry, reuses all existing section IDs, updates only sections affected by the changed files, and appends an entry to design-changelog.md.

Can design docs include language-specific code examples?▼

Yes, but only in the reference/ directory. Normative docs (domain, technical-spec, behavior-spec) must contain zero framework or language names; exact signatures, SQL, and code samples live in reference-impl.md and idiom-notes.md mapped to spec sections by ID.

What happens if the spec is stale when generating design docs?▼

If a spec-staleness block is active, you must resolve or acknowledge it first, since design-doc writes may be blocked by the guardrail. The protocol explicitly warns against blindly retrying on a SPEC_STALENESS_BLOCK error.

Does the design-docs mode modify source code or release changelogs?▼

No. It only creates or updates the fixed set of design docs under the output directory. It never modifies source code, the project spec, CHANGELOG.md, or release-pending artifacts.