zh-docgen
Solid中文文档生成器 - 从代码库自动生成中文技术文档
AI & Automation 835 stars
88 forks Updated yesterday MIT
Install
Quality Score: 86/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
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
- 5 months ago
- Last Updated
- yesterday
- Language
- Python
- License
- MIT
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Listed
generate-doc
Generate documentation — README, API docs, technical docs, changelogs, and usage guides. Use when the user needs new documentation created or template-based document generation.
1 Updated 1 months ago
AVA-2568 AI & Automation Featured
gen-docs
文档生成器。自动分析模块结构,生成 README.md 和 DESIGN.md 骨架。当用户提到生成文档、创建README、创建DESIGN、文档骨架、文档模板时使用。在新建模块开始时自动触发。
5,881 Updated 1 weeks ago
fengshao1227 Code & Development Featured
doc-generator
从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范,或在用户提到 API 文档、端点或说明时使用。
41,440 Updated 5 days ago
luongnv89