doc-generator

Generate OpenAPI specs, changelogs, and setup guides from source code.

Updated Mar 1, 2026
One-click install
npx skills add https://github.com/mqzkim/trading --skill doc-generator-mqzkim
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/mqzkim/trading/tree/main/.agents/skills/doc-generator
Command: npx skills add https://github.com/mqzkim/trading --skill doc-generator-mqzkim

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of essential project documentation, saving developers significant time and ensuring consistency.

Core Features & Use Cases

  • API Documentation: Generates OpenAPI specs from tRPC + Zod schemas.
  • Changelogs: Automatically updates CHANGELOG.md based on git history.
  • Guides: Creates installation and setup guides.
  • Use Case: After updating your API endpoints, use this Skill to automatically regenerate the OpenAPI documentation and update the relevant sections of your README.

Quick Start

Use the doc-generator skill to create API documentation from the '/src/api' directory.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I generate OpenAPI documentation from tRPC and Zod schemas?

To generate OpenAPI documentation from tRPC and Zod schemas, you can use this Skill to automatically extract specifications from your source code and output them as OpenAPI 3.1 JSON, YAML, or Markdown files.

Can I automatically update a CHANGELOG.md file from git history?

Yes, you can automatically update a CHANGELOG.md file from git history by running this Skill, which parses your git logs to generate and append chronological release notes and project changes.

What is the best way to create API installation guides from source code?

The best way to create API installation guides is to use this Skill, which analyzes your source code to automatically generate setup instructions and comprehensive documentation for your project.

Does this API documentation generator support Markdown output formats?

Yes, this API documentation generator supports Markdown output formats, alongside OpenAPI 3.1 JSON and YAML, allowing you to seamlessly integrate generated specs into your README.

How do I keep API documentation updated after modifying endpoints?

To keep API documentation updated after modifying endpoints, run this Skill against your API directory to regenerate OpenAPI specs and automatically update the relevant sections of your README.

Can I use this tool to generate setup instructions for a tRPC project?

Yes, you can use this tool to generate setup instructions for a tRPC project, as it specifically supports extracting OpenAPI specifications from tRPC setups and creating installation guides.