ln-113-backend-docs-creator

Generates API spec and database schema docs from backend context using OpenAPI 3.0 and Mermaid ER diagrams.

Updated Mar 14, 2026
One-click install
npx skills add https://github.com/0xtaoist/taogate --skill ln-113-backend-docs-creator-0xtaoist
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ln-113-backend-docs-creator
Source: https://github.com/0xtaoist/taogate/tree/main/ln-113-backend-docs-creator
Command: npx skills add https://github.com/0xtaoist/taogate --skill ln-113-backend-docs-creator-0xtaoist

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Creates 2 backend docs (api_spec.md, database_schema.md) and orchestrates their generation when backend or database is detected.

Core Features & Use Cases

  • Generates OpenAPI 3.0 compliant api_spec.md and Mermaid ER diagrams for database_schema.md based on coordinator context.
  • Idempotent: only creates documents that do not already exist and updates maintenance notes as needed.
  • Integrates with the ln-110 project-docs-coordinator to receive context data and trigger document generation in CI/CD pipelines.

Quick Start

Run the backend docs creator after a project detects hasBackend or hasDatabase to produce docs automatically.

Frequently Asked Questions about ln-113-backend-docs-creator

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

FAQPage Schema
How do I auto-generate backend documentation from existing API specs and database schemas?

You can auto-generate backend documentation by detecting backend services and databases to produce api_spec.md and database_schema.md files. This process uses OpenAPI 3.0 and Mermaid ER diagrams to ensure consistent, verifiable docs directly from project context.

What is the best way to create OpenAPI 3.0 compliant documentation for REST and GraphQL services?

Creating OpenAPI 3.0 compliant documentation is best handled by generating an api_spec.md file from detected REST or GraphQL backend context. This approach ensures your API specs remain consistent and verifiable with your actual backend services.

How do I generate Mermaid ER diagrams for my database schema documentation?

To generate Mermaid ER diagrams for database schema documentation, you can use a context store to detect your database and output a database_schema.md file. This creates visual, verifiable entity-relationship diagrams directly from your backend context.

Does this backend documentation generator work with CI/CD pipelines?

Yes, the backend documentation generator works with CI/CD pipelines by integrating with a project-docs-coordinator to receive context data. It triggers document generation automatically when a project detects a backend service or database.

Will auto-generating backend docs overwrite my existing API specification files?

Auto-generating backend docs is an idempotent process that will not overwrite existing API specification files. It only creates documents that do not already exist and updates maintenance notes as needed, ensuring your manual changes remain safe.