design-doc-generator

Generate database schemas, API specs, and Mermaid diagrams from requirements.

3|Updated Oct 15, 2025

Search Tags:#design #architecture #templates #documentation #mermaid #openapi #diagrams

Ready to run

npx skills add https://github.com/chaorenex1/coding-workflow --skill design-doc-generator

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: design-doc-generator
Source: https://github.com/chaorenex1/coding-workflow/tree/main/skills/design-doc-generator
Command: npx skills add https://github.com/chaorenex1/coding-workflow --skill design-doc-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Designers and engineers often spend excessive time creating and maintaining comprehensive design documents that cover database schemas, system architecture, API specifications, and Mermaid diagrams; this tool streamlines that process and enforces consistency.

Core Features & Use Cases

Generate end-to-end design documents including database schemas, module interfaces, API specs, data flows, and sequence diagrams.
Provide standardized templates (database-schema, api-spec, module-design) and references to ensure uniform documentation.
Use cases include creating new project docs from requirements, reverse-engineering existing systems, or updating documentation after architecture changes.

Quick Start

Create a full technical design document for a new microservice by detailing database schemas, API specs, and Mermaid diagrams.

Frequently Asked Questions about design-doc-generator

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

FAQPage Schema

How do I generate architecture diagrams and database schemas from software requirements?▼

Design documents generated from requirements provide standardized templates for database schemas, API specifications, and Mermaid sequence diagrams. Using these templates ensures uniform documentation structure, saving designers and engineers the excessive time typically spent manually creating and maintaining comprehensive technical blueprints.

Can I reverse-engineer existing systems into technical design documentation?▼

Design documents include standardized references for database schemas, module interfaces, API specs, data flows, and sequence diagrams. These built-in templates enforce uniform documentation practices across software projects, reducing the manual effort required to maintain consistent technical design blueprints.

How do I create OpenAPI specifications and Mermaid diagrams for a new microservice?▼

You can use generated design documents to update architecture blueprints after system changes. By modifying the input requirements, the tool regenerates module interfaces, API specifications, and Mermaid diagrams, ensuring your technical design documentation stays synchronized with recent software architecture modifications.

What is the best way to standardize API specifications and module design across engineering teams?▼

The best way to standardize API specifications and module design is to use standardized documentation templates. Generating design docs from predefined templates for API specs and module design ensures uniform structure and consistency, eliminating the formatting discrepancies that occur when engineers document architectures manually.