# Zh Docgen

中文文档生成器 - 从代码库自动生成中文技术文档

- Repository: https://github.com/laolaoshiren/claude-code-skills-zh (899 stars)
- Category: Engineering
- License: MIT
- Last updated: 2026-10-31
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen -g -a claude-code -y`
Codex: `npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen -g -a codex -y`
Cursor: `npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen -g -a cursor -y`
Gemini CLI: `npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen -g -a gemini-cli -y`

## Description

中文文档生成器 - 从代码库自动生成中文技术文档

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 中文文档生成器

## 触发条件
当用户要求生成文档、写技术文档、生成 API 文档、项目说明时激活此技能。

## 工作流程

1. **扫描项目结构**, 识别项目类型（Web 应用/CLI 工具/库/服务）
2. **分析代码**, 提取模块、函数、类、接口的签名和注释
3. **生成文档**, 输出以下文档：

### 生成内容
- **项目概述**, 中文简介、技术栈、架构图（Mermaid）
- **快速开始**, 安装、配置、运行步骤
- **API 参考**, 自动生成的接口文档
- **使用示例**, 常见场景的代码示例
- **常见问题**, FAQ 部分

## 输出格式
生成一个或多个 Markdown 文件，中文为主，技术术语保留英文。

## 技巧
- 优先读取已有 README、package.json、pyproject.toml 获取项目元信息
- 分析 import/require 语句推断依赖关系
- 从 docstring/JSDoc 提取已有文档