design-doc

Scaffold structured markdown design documents with required sections.

Updated Mar 20, 2026
One-click install
npx skills add https://github.com/mihai-chiorean/inc --skill design-doc-mihai-chiorean
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-doc
Source: https://github.com/mihai-chiorean/inc/tree/main/skills/design-doc
Command: npx skills add https://github.com/mihai-chiorean/inc --skill design-doc-mihai-chiorean

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill solves the problem of inconsistent, incomplete, or missing design documentation by providing a standardized, mandatory structure for architectural decision-making.

Core Features & Use Cases

  • Structured Scaffolding: Automatically generates a design document template with required sections like user flows, state machines, and data flow diagrams.
  • ADR Pattern Enforcement: Integrates with the repository's decision-making process by assigning sequential identifiers to new design documents.
  • Use Case: Use this when starting a new M-sized or larger feature to ensure all technical requirements, failure modes, and implementation alternatives are documented before coding begins.

Quick Start

Invoke the design-doc skill to scaffold a new design document for your current project by providing a descriptive title.

Frequently Asked Questions about design-doc

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

FAQPage Schema
How do I scaffold a structured design document for a new software feature?

Scaffolding a design document requires generating a structured markdown template via a CLI wrapper. This enforces architectural consistency by ensuring technical planning sections like user flows, state machines, and failure modes are addressed.

What is an architectural decision record and when do I need one?

An architectural decision record (ADR) documents technical decisions for a repository. You need one when starting a new M-sized or larger feature to ensure technical requirements, implementation alternatives, and failure modes are documented before coding begins.

Do I need git to generate architectural documentation templates?

Yes, git is required for path resolution when generating architectural documentation templates. The CLI wrapper uses git to manage template generation, assign sequential ADR identifiers, and organize files within your software engineering workflow.

What's the best way to enforce mandatory sections like state machines in technical planning?

The best way to enforce mandatory sections in technical planning is using a standardized scaffolding tool. It automatically generates markdown templates that require sections for data flow diagrams, state machines, and user flows before development proceeds.

Can I use this scaffolding for small bug fixes or is it only for large features?

This scaffolding is intended for new M-sized or larger features, not small bug fixes. It enforces rigorous architectural consistency by documenting implementation alternatives and failure modes, which is unnecessary overhead for minor code changes.