SkillsAdd

laolaoshiren/claude-code-skills-zh

zh-docgen

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

First seen Apr 23, 2026

Installation

$ npx skills add laolaoshiren/claude-code-skills-zh --skill zh-docgen
View on skills.sh ↗ GitHub repository ↗

Also in this package

Other skills from laolaoshiren/claude-code-skills-zh · top by installs.

npx skills add laolaoshiren/claude-code-skills-zh
zh-code-reviewer 116 refactor-advisor 114 zh-readme 107 api-tester 97 security-audit 92 perf-profiler 92 i18n-helper 88 log-analyzer 87 dep-auditor 87 test-generator 87

Browse all from laolaoshiren/claude-code-skills-zh

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 818
License LICENSE
Default branch main
Open issues 1
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Declared agents claude-code

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,040 B
  • docs SUMMARY.md 83 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 98 installs

SKILL.md

中文文档生成器

触发条件

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

工作流程

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

生成内容

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

输出格式

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

技巧

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