Skip to content
zh-docgen logo

中文文档生成器

zh-docgen

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

SKILL.md

Full skill instructions

中文文档生成器

触发条件

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

工作流程

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

生成内容

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

输出格式

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

技巧

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

More skills from laolaoshiren

test-generator logo
laolaoshiren/claude-code-skills-zh

test-generator

自动生成单元测试:识别函数逻辑、覆盖边界条件、生成可运行测试代码

876 0
View
git-workflow logo
laolaoshiren/claude-code-skills-zh

git-workflow

Git 工作流自动化 - 智能分支管理、提交信息生成、PR 创建

876 0
View
db-migrator logo
laolaoshiren/claude-code-skills-zh

db-migrator

数据库迁移助手 - Schema 对比、迁移脚本生成

876 0
View
i18n-helper logo
laolaoshiren/claude-code-skills-zh

i18n-helper

国际化/本地化助手 — 扫描代码中的硬编码文本、生成 i18n 配置、批量翻译

876 0
View
zh-code-reviewer logo
laolaoshiren/claude-code-skills-zh

zh-code-reviewer

中文代码审查专家 - 生成详细的中文代码审查报告

876 0
View
log-analyzer logo
laolaoshiren/claude-code-skills-zh

log-analyzer

日志分析助手 — 智能解析日志文件,识别异常模式,定位问题根因

876 0
View
github-actions-gen logo
laolaoshiren/claude-code-skills-zh

github-actions-gen

GitHub Actions CI/CD 流水线生成器:根据项目技术栈自动创建 workflows

876 0
View
error-translator logo
laolaoshiren/claude-code-skills-zh

error-translator

编程错误消息翻译专家 — 将英文错误消息翻译成中文,解释原因并提供修复方案

876 0
View
api-tester logo
laolaoshiren/claude-code-skills-zh

api-tester

API 自动化测试 - OpenAPI 解析、测试用例生成、集成测试

876 0
View
security-audit logo
laolaoshiren/claude-code-skills-zh

security-audit

代码安全审计 - 漏洞扫描、依赖检查、安全最佳实践

876 0
View
eslint-fix logo
laolaoshiren/claude-code-skills-zh

eslint-fix

ESLint 自动修复专家 — 识别 ESLint 报错,批量修复,支持常见规则和自定义配置

876 0
View
env-manager logo
laolaoshiren/claude-code-skills-zh

env-manager

环境变量管理器:扫描、校验、同步 .env 文件,生成安全配置模板

876 0
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View