design-doc-required

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."