devbooks-design-doc

Generates a design.md defining What, Constraints, and ACs for a change package.

84|6|Updated Jan 12, 2026
One-click install
npx skills add https://github.com/Darkbluelr/dev-playbooks-cn --skill devbooks-design-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: devbooks-design-doc
Source: https://github.com/Darkbluelr/dev-playbooks-cn/tree/main/skills/devbooks-design-doc
Command: npx skills add https://github.com/Darkbluelr/dev-playbooks-cn --skill devbooks-design-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill guides the creation of Design Docs that capture only What/Constraints and ACs, ensuring verifiability and traceability for each change package without detailing implementation steps.

Core Features & Use Cases

  • Enforces the Design Doc structure to include What, Constraints, and ACs, plus Documentation Impact and Architecture Impact sections.
  • References existing truth specs and invariants to maintain alignment with the current source of truth.
  • Supports downstream workflows by producing a design.md that serves as the Golden Truth for planning (spec-contract, implementation-plan, test-owner, coder).

Quick Start

Place a complete design.md at <change-root>/<change-id>/design.md that contains What/Constraints/ACs and references relevant specs.

Frequently Asked Questions about devbooks-design-doc

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

FAQPage Schema
How do I write a design doc that ensures traceability to existing requirements and specs?

A design doc ensures traceability by defining What, Constraints, and Acceptance Criteria, then explicitly citing affected requirements and invariants from existing source of truth specs. This structure links each change package directly to established glossary and spec definitions.

What is the best way to structure a design doc for proposal planning without detailing implementation steps?

Structure the design doc by capturing only What, Constraints, and Acceptance Criteria, plus Documentation Impact and Architecture Impact sections. This verifiable format focuses on defining the change package boundaries rather than outlining the actual implementation steps.

How does generating a design.md file support downstream spec-contract and implementation-plan workflows?

Generating a design.md file creates a Golden Truth reference for downstream workflows like spec-contract, implementation-plan, test-owner, and coder. It provides the approved What, Constraints, and Acceptance Criteria needed to generate accurate downstream contracts and plans.

Do I need existing truth specs and invariants before creating a design doc for a change package?

Yes, existing truth specs and invariants are required. The design doc references these established sources of truth to maintain alignment, ensuring the new change package respects current architecture and requirements definitions before proposal planning proceeds.

Can I use a design doc approach for changes if my project lacks formal acceptance criteria?

A design doc approach actually helps establish formal acceptance criteria by enforcing a structure that requires them. By generating the document with What, Constraints, and ACs, you define verifiable conditions even if your project previously lacked them.

Why does my design doc need Architecture Impact and Documentation Impact sections for a change package?

Architecture Impact and Documentation Impact sections are needed to assess how a change package alters the current system structure and existing truth specs. They ensure the design doc captures verifiable constraints and maintains alignment with the broader technical architecture.