moai-docs-generation

Generate API documentation from source code with multi-format outputs.

1.2k|214|Updated Sep 16, 2025
One-click install
npx skills add https://github.com/modu-ai/moai-adk --skill moai-docs-generation-modu-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: moai-docs-generation
Source: https://github.com/modu-ai/moai-adk/tree/main/.claude/skills/moai-docs-generation
Command: npx skills add https://github.com/modu-ai/moai-adk --skill moai-docs-generation-modu-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates API docs, architecture specs, code docs, and user guides with multi-format outputs.

Core Features & Use Cases

  • API docs, code docs, user guides
  • Multi-format outputs (markdown, html, pdf)
  • AI-assisted enhancements and doc quality checks

Quick Start

moai docs:generate --source ./src --output ./docs --formats html,markdown,pdf

Frequently Asked Questions about moai-docs-generation

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

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

API documentation generation automates creating docs directly from your codebase using AST analysis and OpenAPI specifications. moai-docs-generation extracts code structure, generates multi-format outputs (Markdown, HTML, PDF), and enriches content with AI assistance, eliminating manual documentation maintenance.

Can I export documentation in multiple formats like HTML, PDF, and Markdown?▼

Yes, multi-format export lets you generate Markdown, HTML, and PDF outputs from a single source in one command. moai-docs-generation handles format conversion automatically, so you maintain docs in one place and distribute them across channels.

How do I integrate automated documentation generation into my CI/CD pipeline?▼

Documentation generation integrates into CI/CD by running as an automated step triggered on code changes. moai-docs-generation connects with version control and CI/CD systems to continuously update docs whenever your source code or specifications change.

What's the best way to keep technical documentation in sync with code changes?▼

Continuous documentation updates tie docs to your version control workflow, regenerating them automatically when code updates. moai-docs-generation eliminates drift by analyzing current source code and specifications each time it runs, ensuring docs always reflect your latest implementation.

Can I enhance code documentation quality with AI assistance?▼

AI-assisted content enrichment improves doc quality by analyzing code patterns and generating clearer descriptions automatically. moai-docs-generation applies AI enhancement to code docs and guides, supplementing extracted content and improving readability without manual rewrites.

Do I need to manually write OpenAPI specifications for API documentation?▼

OpenAPI specification generation creates specs automatically from your source code analysis instead of requiring manual definition. moai-docs-generation extracts API structure through AST parsing and generates standards-compliant OpenAPI specs, reducing setup overhead.