Doc Generator
Documentsdoc-generatorDoc Generator is an Agent Skill for documents published in the lhfer/claude-howto-zh-cn repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
从源码生成准确、完整的 API 文档和技术说明。Use when creating or updating API docs, generating endpoint documentation, or when users mention API docs, endpoints, or documentation.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/lhfer/claude-howto-zh-cn/blob/HEAD/03-skills/doc-generator/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/doc-generator, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
API Documentation Generator Skill / API 文档技能
生成内容
- OpenAPI / Swagger 文档
- endpoint 文档
- SDK 示例
- 集成指南
- 错误码说明
- 鉴权说明
每个 endpoint 需要包含
输出尽量包含：
- Description（说明）
- Parameters（参数）
- Response
- Errors
- cURL / JavaScript / Python 示例
要求：
- 文档结构清晰
- 示例可复制
- 与源码保持一致