API Documentation Generator Skill / API 文档技能
生成内容
- OpenAPI / Swagger 文档
- endpoint 文档
- SDK 示例
- 集成指南
- 错误码说明
- 鉴权说明
每个 endpoint 需要包含
输出尽量包含:
- Description(说明)
- Parameters(参数)
- Response
- Errors
- cURL / JavaScript / Python 示例
要求:
- 文档结构清晰
- 示例可复制
- 与源码保持一致
从源码生成准确、完整的 API 文档和技术说明。Use when creating or updating API docs, generating endpoint documentation, or when users mention API docs, endpoints, or documentation.
| Publisher | lhfer |
| Repository | claude-howto-zh-cn |
| Skill name | doc-generator |
| Stars | 2.3K |
| Forks | 331 |
| Bundled files | 1 |
| License | MIT |
| Links |
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Published by lhfer on GitHub. Read the source before you install it.
Install the Doc Generator AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.
TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.
Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.
git clone --depth 1 https://github.com/lhfer/claude-howto-zh-cn.git /tmp/claude-howto-zh-cn
mkdir -p .claude/skills
cp -r /tmp/claude-howto-zh-cn/03-skills/doc-generator .claude/skills/doc-generatorEnable Doc Generator in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.
AI skills are plain Markdown instructions rather than provider-specific code, so Doc Generator is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.
This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.
输出尽量包含:
要求:
The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.
从源码生成准确、完整的 API 文档和技术说明。Use when creating or updating API docs, generating endpoint documentation, or when users mention API docs, endpoints, or documentation.
Because you install it once and use it with any model. Doc Generator is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.
Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/lhfer/claude-howto-zh-cn/tree/main/03-skills/doc-generator. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.
Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.
As many as you like. As long as a model supports skills, you can use Doc Generator with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.
Yes. It is published on GitHub by lhfer under the MIT license. You only pay your own AI provider for the tokens you use.
An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.
A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.
Ask Matt
Ask which skill or flow fits your situation. A router over the skills in this repo.
Code Review
Review the changes since a fixed point (commit, branch, tag, or merge-base) along two axes: Standards (does the code follow this repo's documented coding standards?) and Spec (does the code match what…
Codebase Design
Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or…
Diagnosing Bugs
Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throwing/failing/slow.
Get notified about new features and future giveaways by subscribing to our newsletter 👇
