How to install zh-docgen
install zh-docgen
# install the claude-code-skills-zh pack with the skills CLI
npx skills add laolaoshiren/claude-code-skills-zh# or add only this skill to Claude Code: copy the folder
skills/zh-docgen/
# into
~/.claude/skills/zh-docgen/ (all projects)
.claude/skills/zh-docgen/ (one project)
1# 中文文档生成器23## 触发条件4当用户要求生成文档、写技术文档、生成 API 文档、项目说明时激活此技能。56## 工作流程781. **扫描项目结构** — 识别项目类型(Web 应用/CLI 工具/库/服务)92. **分析代码** — 提取模块、函数、类、接口的签名和注释103. **生成文档** — 输出以下文档:1112### 生成内容13- **项目概述** — 中文简介、技术栈、架构图(Mermaid)14- **快速开始** — 安装、配置、运行步骤15- **API 参考** — 自动生成的接口文档16- **使用示例** — 常见场景的代码示例17- **常见问题** — FAQ 部分1819## 输出格式20生成一个或多个 Markdown 文件,中文为主,技术术语保留英文。2122## 技巧23- 优先读取已有 README、package.json、pyproject.toml 获取项目元信息24- 分析 import/require 语句推断依赖关系25- 从 docstring/JSDoc 提取已有文档
Excerpt shown under the repository's MIT license.
