zh-docgen

Name: zh-docgen
Author: laolaoshiren/claude-code-skills-zh

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

Generates Chinese technical documentation from codebases automatically.

Solves the problem of manually writing and maintaining Chinese technical docs.
Depends on scanning project files like README, package.json, pyproject.toml.
Decides what to document by analyzing code structure, imports, and docstrings.
Delivers results as one or more Markdown files with Chinese text and English terms.

SKILL.md

.github/skills/zh-docgenView on GitHub ↗

---
name: zh-docgen
description: 中文文档生成器 - 从代码库自动生成中文技术文档
---

# 中文文档生成器

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

## 工作流程

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

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

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

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

More from laolaoshiren/claude-code-skills-zh

Skill	Description
api-tester	依据真实 OpenAPI、路由实现和现有测试生成并验证 API 测试。用于用户要求测试接口、补集成测试、验证 API 契约、生成回归用例或排查接口兼容性时；区分“生成测试”和“执行请求”的授权，不猜测状态码、响应结构或 SLA，不在未确认环境中发送写请求。
changelog-gen	Changelog 生成器 - 从 Git 历史自动生成 CHANGELOG
db-migrator	数据库迁移助手 - Schema 对比、迁移脚本生成
dep-auditor	审计 Node.js、Python、Go、Rust、JVM、Ruby 项目的依赖漏洞、版本健康度与许可证事实；当用户要求检查 package.json、lockfile、requirements、go.mod、Cargo.toml、pom.xml、Gemfile.lock，或生成不改依赖的中文审计报告时使用
ds-mapper	项目目录结构地图 - 生成带说明的可视化目录树，快速理解任意代码库
env-manager	环境变量管理器：扫描、校验、同步 .env 文件，生成安全配置模板
error-translator	编程错误消息翻译专家 — 将英文错误消息翻译成中文，解释原因并提供修复方案
eslint-fix	安全诊断并修复 ESLint error、warning 和配置兼容问题。用于用户要求运行 lint、解释 ESLint 报错、限定范围自动修复或迁移 ESLint 配置时；优先使用项目锁定的包管理器与版本，先预检再修改，不自动下载最新版或批量改写无关源码。
github-actions-gen	分析真实项目并生成或修订安全、可验证的 GitHub Actions workflow；当用户要求创建 CI、测试矩阵、构建、Release、部署、缓存、Secrets、OIDC、PR 自动化或排查 workflow 配置时使用
i18n-helper	国际化/本地化助手 — 扫描代码中的硬编码文本、生成 i18n 配置、批量翻译