documentation-generation-doc-generate

Extract code metadata to generate OpenAPI specs, Mermaid diagrams, and developer guides.

1|1|Updated Jul 29, 2025
One-click install
npx skills add https://github.com/M-Abdullah07/Pharmacy-Billing-App --skill documentation-generation-doc-generate-m-abdullah07
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-generation-doc-generate
Source: https://github.com/M-Abdullah07/Pharmacy-Billing-App/tree/main/.agent/skills/documentation-generation-doc-generate
Command: npx skills add https://github.com/M-Abdullah07/Pharmacy-Billing-App --skill documentation-generation-doc-generate-m-abdullah07

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Codebases often generate rich information that is under-documented or out of sync, creating knowledge gaps for developers, product teams, and operators.

Core Features & Use Cases

  • API Documentation generation (OpenAPI specs, reference docs)
  • Architecture diagrams and system overviews (Mermaid/PlantUML)
  • Developer guides and user-facing documentation extracted from code comments and config
  • CI/CD automation to publish living docs and keep them synchronized with code changes

Quick Start

Analyze the codebase and generate API docs, architecture diagrams, and developer guides.

Frequently Asked Questions about documentation-generation-doc-generate

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

FAQPage Schema
How do I generate OpenAPI specs and architecture diagrams directly from source code?

You can generate OpenAPI specs and architecture diagrams by extracting code metadata from your source and configuration files. This process produces API documentation, system overviews in Mermaid or PlantUML, and developer references automatically.

How do I keep my API documentation synchronized with code changes in a CI/CD workflow?

To keep API documentation synchronized with code changes, you can automate publishing within your CI/CD workflows. This approach treats documentation as living docs, regenerating API specs and developer references whenever the source code is updated.

What is the best way to create living docs that stay up-to-date for a software project?

The best way to create living docs is to extract code metadata to generate comprehensive documentation across API specs, architecture diagrams, and user guides. This ensures developer references and system diagrams remain synced with the codebase.

Can I generate both developer guides and user-facing documentation from code comments?

Yes, you can generate developer guides and user-facing documentation by extracting information from code comments and configuration files. This extracts existing codebase information to bridge knowledge gaps for developers, product teams, and operators.

Does automated code analysis work for generating documentation across software projects of varying sizes?

Yes, automated code analysis applies to software projects of varying sizes. By extracting code metadata, it meets the requirements for generating API specs, system diagrams, and developer references regardless of project scale.