zh-docgen

Solid

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

AI & Automation 692 stars 69 forks Updated today MIT

Install

View on GitHub

Quality Score: 86/100

Stars 20%
95
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
23
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 中文文档生成器 ## 触发条件 当用户要求生成文档、写技术文档、生成 API 文档、项目说明时激活此技能。 ## 工作流程 1. **扫描项目结构** — 识别项目类型(Web 应用/CLI 工具/库/服务) 2. **分析代码** — 提取模块、函数、类、接口的签名和注释 3. **生成文档** — 输出以下文档: ### 生成内容 - **项目概述** — 中文简介、技术栈、架构图(Mermaid) - **快速开始** — 安装、配置、运行步骤 - **API 参考** — 自动生成的接口文档 - **使用示例** — 常见场景的代码示例 - **常见问题** — FAQ 部分 ## 输出格式 生成一个或多个 Markdown 文件,中文为主,技术术语保留英文。 ## 技巧 - 优先读取已有 README、package.json、pyproject.toml 获取项目元信息 - 分析 import/require 语句推断依赖关系 - 从 docstring/JSDoc 提取已有文档

Details

Author
laolaoshiren
Repository
laolaoshiren/claude-code-skills-zh
Created
3 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category