---
name: Chinese Documentation Generator
slug: chinese-documentation-generator
category: Writing
description: Chinese Documentation Generator creates Chinese technical documentation from a codebase, including project overviews, quick start guides, API references, examples, and FAQs. Use it when you need Markdown docs for a project or API.
github: "https://github.com/laolaoshiren/claude-code-skills-zh/tree/main/skills/zh-docgen"
language: Python
stars: 786
forks: 84
install: "npx degit https://github.com/laolaoshiren/claude-code-skills-zh/tree/main/skills/zh-docgen ~/.claude/skills/zh-docgen"
installs_to: ~/.claude/skills/zh-docgen
source_path: skills/zh-docgen/SKILL.md
collection_size: 20
category_size: 1012
collection_url: "https://dirskills.com/collections/laolaoshiren/claude-code-skills-zh"
added: 2026-08-23T05:19:03.539Z
last_synced: 2026-08-23T05:19:03.539Z
canonical_url: "https://dirskills.com/skills/chinese-documentation-generator"
---

# Chinese Documentation Generator

Chinese Documentation Generator creates Chinese technical documentation from a codebase, including project overviews, quick start guides, API references, examples, and FAQs. Use it when you need Markdown docs for a project or API.

**Install:**

```bash
npx degit https://github.com/laolaoshiren/claude-code-skills-zh/tree/main/skills/zh-docgen ~/.claude/skills/zh-docgen
```

## README

# 中文文档生成器

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

## 工作流程

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

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

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

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