Skip to content
alyn
laolaoshiren

Zh Docgen skill

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

$npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen
View this skill on GitHublaolaoshiren/claude-code-skills-zh/skills/zh-docgen/SKILL.md
Pack stars
906
Pack installs
1.8k
Alyn Score
50/99
Updated
1 h ago
License
MIT
– views – installs via Alyn

laolaoshiren

Zh Docgen

Coding

Install Zh Docgen

Pick your agent. Every command is ready to paste.

$npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen

The open skills CLI detects your agents (Claude Code, Cursor, Codex and 70+ more) and installs to the right folder. Add -g to install globally.

01

Install it

Run the command above, or upload the folder in Claude.

02

Ask naturally

Describe the task. Your agent loads zh-docgen when the request matches its description.

03

Name it if needed

If it does not trigger, say “use the zh-docgen skill”. In Codex, type $zh-docgen.

The skill itself

SKILL.md

FolderGitHub

中文文档生成器

触发条件

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

工作流程

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

生成内容

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

输出格式

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

技巧

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

Tips for Zh Docgen

  • • Start a fresh session after installing so your agent picks up the new skill.
  • • It is part of a pack with 21 skills. Install only the ones you need with --skill to keep triggers precise.
  • • If two skills overlap, mention the one you want by name.

Questions about Zh Docgen

What does the Zh Docgen skill do?

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

How do I install Zh Docgen?

Run "npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen" in your project. The skills CLI installs it for Claude Code, Cursor, Codex and 70+ other agents. In Claude on the web, upload the skill folder as a ZIP under Customize > Skills.

Does Zh Docgen work in Cursor and Codex?

Yes. Zh Docgen uses the open SKILL.md format, so it works in Claude Code, Claude, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot and other agents that support agent skills.

Is Zh Docgen free?

Zh Docgen is open source on GitHub under the MIT license. It is free to install; check the license before commercial use.

Who made Zh Docgen?

Zh Docgen is published by laolaoshiren in the laolaoshiren/claude-code-skills-zh repository, together with 20 other skills.

Similar skills. From other creators.