design-docs

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

Updated May 31, 2026
One-click install
npx skills add https://github.com/AlexanderNarbaev/agi --skill design-docs-alexandernarbaev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-docs
Source: https://github.com/AlexanderNarbaev/agi/tree/main/.opencode/skills/design-docs
Command: npx skills add https://github.com/AlexanderNarbaev/agi --skill design-docs-alexandernarbaev

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 actual system. ## Core Features & Use Cases - Structured Doc Generation: Creates a fixed set of design documents (domain, technical spec, behavior spec, reference/) with stable section IDs (D-###, S-###, B-###, R-###) that are never renumbered. - Sync Mode: Updates existing docs to match current code and spec changes, preserving all existing section IDs and appending entries to a design changelog. - Traceability Registry: Maintains a machine-readable traceability.json mapping every section to spec FR IDs, invariants, and code anchors. - Use Case: After completing a development phase, trigger a sync so the design docs reflect the new behavior specs and the traceability table stays aligned with the requirements spec. ## Quick Start Ask the agent to generate design docs for the project into the docs directory using the DESIGN_DOCS mode with a short system description.

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 for a software project?

Dispatch the DESIGN_DOCS mode with an output directory and a system description. The docs_design agent creates domain.md, technical-spec.md, behavior-spec.md, and a reference/ folder with stable section IDs and a traceability registry.

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

Run the mode with update set to true. The agent indexes existing docs, preserves all existing section IDs, updates only affected sections, and appends an entry to design-changelog.md describing what changed.

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 never modifies source code, CHANGELOG.md, or release artifacts.

Why are framework names not allowed in the design docs?

The normative documents (domain, technical-spec, behavior-spec) must remain language-agnostic so the design survives technology changes. All language- or framework-specific material is isolated in the reference/ directory and mapped to spec sections by ID.

What happens when design docs drift from the code?

During phase wrap-up, a deterministic drift check writes a doc-drift report. If the verdict is DOC_STALE, the docs_design agent is dispatched in sync mode for the affected sections only, which is advisory and never blocks phase completion.