design-doc-required

Block code edits until validated design and coding-summary documents exist.

6|1|Updated Mar 30, 2026
One-click install
npx skills add https://github.com/exception-coder/team-standards --skill design-doc-required
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-doc-required
Source: https://github.com/exception-coder/team-standards/tree/main/skills/design-doc-required
Command: npx skills add https://github.com/exception-coder/team-standards --skill design-doc-required

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prevents premature analysis, architecture discussion, or source code edits by ensuring a formal design document and a corresponding coding-summary exist and are validated before any implementation begins. This reduces rework, avoids undocumented assumptions, and keeps architecture decisions auditable and consistent with project indexes.

Core Features & Use Cases

  • Hard gating: Blocks any analysis or Edit/Write on source files until design doc and -coding.md gates pass.
  • Context pre-warm: Reads docs/00_project_overview.md when present to load project knowledge and route required readings.
  • Index and placement checks: Calls doc-index-required Phase-A/B to verify document boundaries and update docs/design/INDEX.md as needed.
  • Coding-summary enforcement: Generates or requires a {requirement}-coding.md before the first line of implementation and extracts full-path class lists and method-level guidance.
  • Mermaid and diagram rules: Enforces mermaid diagram types, subgraph/box grouping and delegates syntax validation to markdown-writing-standards.
  • Use cases: new feature requests, refactors with behavior change, interface updates, code modifications initiated from design documents or user requests.

Quick Start

Ask the assistant to "Run the design-doc-required check for this task and verify or create a compliant docs/design/ file and its matching -coding.md before any code edits."

Frequently Asked Questions about design-doc-required

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

FAQPage Schema
How do I enforce a design document requirement before writing code?

To enforce a design document requirement before writing code, use a hard gating mechanism that blocks source file edits until a validated design doc and coding-summary are confirmed. This prevents premature implementation and avoids undocumented assumptions.

When do I need a coding-summary file for a new feature implementation?

You need a coding-summary file before the first line of implementation when proposing new requirements, behavior-changing refactors, or bug fixes. It extracts full-path class lists and method-level guidance to ensure implementation matches the validated design document.

How do I validate Mermaid diagrams in a software design doc?

To validate Mermaid diagrams in a software design doc, enforce specific diagram types and subgraph/box grouping rules, then delegate syntax validation to markdown-writing-standards. This ensures architecture decisions remain auditable and consistent.

Does blocking source code edits before architecture discussion improve compliance?

Blocking source code edits before architecture discussion improves compliance by preventing premature analysis. It ensures formal design documents are validated, project indexes are updated via doc-index-required Phase-A and Phase-B, and documentation boundaries are verified.

What is the best way to structure pre-implementation design documents?

The best way to structure pre-implementation design documents is placing them in a docs/design/ directory using -current.md and -coding.md files, while reading docs/00_project_overview.md to load project knowledge and route required readings before any edits.

Can I run source file edits without a matching design doc and coding file?

You cannot run source file edits without a matching design doc and coding file. The hard gate blocks any Edit or Write operations until both the design document and the corresponding coding-summary are confirmed present and compliant.