skills.rest
oimiragieo
oimiragieoCOMMUNITY
Explore all skills by this author →
GitHub

doc-generator

Generate API documentation, developer guides, and OpenAPI/Swagger specs from code.

36|6|Updated Nov 2, 2025
Search Tags:#documentation#API#OpenAPI#Swagger#documentation standards#dev guides
One-click install
npx skills add https://github.com/oimiragieo/LLM-RULES --skill doc-generator-oimiragieo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/oimiragieo/LLM-RULES/tree/main/.claude/skills/doc-generator
Command: npx skills add https://github.com/oimiragieo/LLM-RULES --skill doc-generator-oimiragieo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of documentation from code, APIs, and specifications, reducing manual drafting time and ensuring consistency.

Core Features & Use Cases

  • Generating API documentation: Produce API references from endpoints
  • Creating developer guides: Setup and usage documentation
  • Documenting architecture: High-level system docs
  • Creating user manuals: End-user guides and tutorials
  • Generating OpenAPI/Swagger specs: Derive specs from code

Quick Start

Use the doc generator to create API docs for app/api/users

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I generate API documentation from code automatically?▼

Generate API documentation by extracting endpoints, parameters, and responses directly from your codebase. The doc generator analyzes code comments and specifications to produce comprehensive API references with examples, reducing manual documentation time while maintaining consistency across your API surface.

Can I create OpenAPI and Swagger specs from my existing code?▼

Yes, derive OpenAPI and Swagger specifications directly from your code. The doc generator extracts API structure, request/response schemas, and endpoint details to produce standardized specs that serve as both documentation and integration references.

What's the best way to document multiple codebases and APIs in one place?▼

Consolidate documentation across codebases and deployment contexts using templates and consistent extraction rules. The doc generator handles architecture documentation, developer guides, and user manuals alongside API references, ensuring unified structure and completeness validation across your entire system.

How do I ensure my developer guides stay synchronized with code changes?▼

Generate developer guides from code comments and specifications rather than maintaining them separately. The tool validates completeness and consistency automatically, catching gaps and inconsistencies when code updates occur.

Do I need to manually write code comments for documentation to work?▼

Code comments enhance documentation quality, but the doc generator also extracts structure and patterns from code itself. Comments enable richer guides and examples, while specifications and endpoints are discoverable directly from your codebase without manual annotation.

Related Skills

Explore More Content & Communication Skills→
tomique34tomique34
8

api-docs-generator

Generate Markdown API documentation from OpenAPI specs, Python docstrings, and JSDoc/TSDoc comments.

Community
Advanced
SSiertsemaSSiertsema

documentation-tooling-selection

Evaluate documentation tooling against audience, content, and technical criteria.

Community
Advanced
camilooscargbaptistacamilooscargbaptista
7

api-documentation

Generate and review OpenAPI 3.1 specs for REST and GraphQL APIs.

Community
Intermediate
rochacbrunorochacbruno
866

marmite

Convert markdown files into complete static websites without manual configuration.

Community
Intermediate