关于 zh-docgen
zh-docgen 是用于生成中文项目文档的技能，面向需要编写技术说明或 API 文档的用户。它通过扫描项目结构和代码，生成包含概述、快速开始、API 参考、示例与常见问题的 Markdown 文档。
主要功能
- 01扫描项目结构并识别类型
- 02提取代码签名与注释
- 03生成项目概述和架构图
- 04生成快速开始与 API 参考
- 05输出示例和常见问题
适用场景
- 01为现有项目生成中文说明
- 02从代码生成 API 文档
- 03为项目补充安装和运行步骤
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/zh-docgen确认已加载。
详细介绍
来自项目 README中文文档生成器
触发条件
当用户要求生成文档、写技术文档、生成 API 文档、项目说明时激活此技能。
工作流程
- 扫描项目结构 — 识别项目类型（Web 应用/CLI 工具/库/服务）
- 分析代码 — 提取模块、函数、类、接口的签名和注释
- 生成文档 — 输出以下文档：
生成内容
- 项目概述 — 中文简介、技术栈、架构图（Mermaid）
- 快速开始 — 安装、配置、运行步骤
- API 参考 — 自动生成的接口文档
- 使用示例 — 常见场景的代码示例
- 常见问题 — FAQ 部分
输出格式
生成一个或多个 Markdown 文件，中文为主，技术术语保留英文。
技巧
- 优先读取已有 README、package.json、pyproject.toml 获取项目元信息
- 分析 import/require 语句推断依赖关系
- 从 docstring/JSDoc 提取已有文档
评论
支持 Markdown