doc-generator

Generate README, API docs, changelog, and user manuals from source code.

1|Updated Apr 6, 2026
One-click install
npx skills add https://github.com/zhu637882-stack/jiaoyi --skill doc-generator-zhu637882-stack
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/zhu637882-stack/jiaoyi/tree/main/qoder-config-backup/skills/doc-generator
Command: npx skills add https://github.com/zhu637882-stack/jiaoyi --skill doc-generator-zhu637882-stack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

自动读取代码,生成 README、API 文档、更新日志、以及用户手册,输出完整的中文文档,避免手动编写和维护的重复工作。

Core Features & Use Cases

  • 自动生成 README:包含项目简介、功能特性、技术栈、快速开始、项目结构、使用说明。
  • 自动生成 API 文档:从后端代码提取接口、参数、返回值及错误码示例,形成可读的文档。
  • 自动生成用户手册:按功能整理操作步骤与使用场景,便于终端用户使用。
  • 自动更新 CHANGELOG:基于 git 提交历史生成版本变更记录。
  • Use Case: 当代码变更或新功能加入时,自动更新相关文档以确保发布一致性。

Quick Start

Generate complete project documentation from the codebase.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I automatically generate a README and API documentation from source code?

You can automatically generate a README and API documentation from source code by reading the code structure to extract project intros, tech stacks, and API parameters, formatting the outputs into readable markdown files.

How do I create a changelog automatically from git commit history?

You can create a changelog automatically from git commit history by integrating with version history to build version change records, generating formatted markdown outputs for releases, bug fixes, or feature additions.

What is the best way to generate user manuals and documentation for software projects of any size?

The best way to generate user manuals for software projects of any size is to read code structure and automatically organize operation steps and usage scenarios into formatted markdown documents for terminal users.

Can I automatically update markdown documentation when new features are added to the codebase?

Yes, you can automatically update markdown documentation when new features are added by reading code changes and applying automatic doc generation to ensure release consistency across README, API docs, and changelogs.

Does automated documentation generation work without external dependencies?

Yes, automated documentation generation works without external dependencies, as it directly reads code structure and version history to produce markdown outputs for multiple document types.

Why does automatic code documentation generation focus on markdown outputs?

Automatic code documentation generation focuses on markdown outputs because markdown provides a standardized, readable format for structuring READMEs, API docs, and changelogs directly extracted from source code.