document-driven-development
CommunityVerify code changes against project docs first.
System Documentation
What problem does it solve?
Ensures all code changes are grounded in the project's documentation, preventing drift and misinterpretation.
Core Features & Use Cases
-
Locate and read the relevant docs (docs/architecture/.md, docs/api/.yaml, docs/schema/*.sql, READMEs, config files) before making changes.
-
Verify that proposed changes conform to documented design intents, service boundaries, and constraints.
-
If documentation conflicts with implementation, do not modify code to match undocumented behavior; report discrepancies and decide whether to update docs or adjust code.
-
Cite documentation during changes with explicit references, e.g., "According to architecture.md section X" and "API spec dictates...".
-
Common Documentation Locations:
-
Architecture: docs/architecture/microservices.md
-
Data Flow: docs/architecture/data-flow.md
-
API Specs: docs/api/
-
Database Schema: configs/mysql/init.sql
-
Service READMEs: services/*/README.md
-
Red Flags:
-
Don't guess or improvise; verify against docs.
-
Do reference and confirm consistency with intent.
-
Output guidelines and expectations for compliance.
Quick Start
Before editing any code, locate the relevant documentation and verify all changes against it.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: document-driven-development Download link: https://github.com/XingYu55555/mysql-db-practice/archive/main.zip#document-driven-development Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.