ln-113-backend-docs-creator

Generate api_spec.md and database_schema.md from coordinator context.

534|73|Updated Oct 24, 2025
One-click install
npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-113-backend-docs-creator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ln-113-backend-docs-creator
Source: https://github.com/levnikolaevich/claude-code-skills/tree/main/ln-113-backend-docs-creator
Command: npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-113-backend-docs-creator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill conditionally generates backend documentation:

  • docs/project/api_spec.md (OpenAPI-style)
  • docs/project/database_schema.md (ER diagram + data dictionary)

It relies on context from the coordinator and templates to produce consistent backend docs.

Core Features & Use Cases

  • Conditional generation based on hasBackend/hasDatabase flags
  • Create OpenAPI-like API specification and ER diagrams
  • Validate and maintain the documentation structure
  • Return file paths for downstream linking

Quick Start

Execute ln-113-backend-docs-creator in a project with backend/database to produce API specs and database schema docs.

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 generate OpenAPI documentation for my backend API?

OpenAPI-style API specifications are generated automatically from your project's backend context. This Skill creates an api_spec.md file in OpenAPI 3.0 format, extracting endpoint definitions, request/response schemas, and authentication details from coordinator-provided backend data to produce standards-compliant API documentation.

Can I create ER diagrams and database schema documentation automatically?

Yes, this Skill generates database_schema.md with Mermaid ER diagrams and a data dictionary. It automatically produces entity relationships, field definitions, and cardinality from your database context, requiring only that hasDatabase is true and the coordinator supplies the schema data.

What's required before I can generate backend documentation files?

Your project needs backend and/or database context supplied by the project docs coordinator (ln-110). The Skill operates conditionally: it generates api_spec.md only if hasBackend is true and database_schema.md only if hasDatabase is true. Both templates are applied idempotently with placeholder substitution.

Does this create documentation that stays in sync with my codebase?

The Skill produces idempotent file creation and includes self-validation with phase checks and status reporting. Documentation is generated from coordinator-provided context snapshots; staying synchronized depends on re-running the Skill when your backend or database context changes.

How do I use the generated API spec and database schema files?

The Skill returns file paths (docs/project/api_spec.md and docs/project/database_schema.md) for downstream linking and integration. These files use OpenAPI 3.0 format and Mermaid syntax respectively, making them compatible with documentation sites, API gateways, and schema visualization tools.