zh-docgen
中文文档生成器 - 从代码库自动生成中文技术文档
它会碰到什么
扫了多少1 个文本文件,1 KB
它会碰到什么不碰外部(只输出文字)
命中总数0 处
命中统计严重 0 · 高 0 · 中 0 · 低 0
这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。
技能内容
中文文档生成器
触发条件
当用户要求生成文档、写技术文档、生成 API 文档、项目说明时激活此技能。
工作流程
- 扫描项目结构 — 识别项目类型(Web 应用/CLI 工具/库/服务)
- 分析代码 — 提取模块、函数、类、接口的签名和注释
- 生成文档 — 输出以下文档:
生成内容
- 项目概述 — 中文简介、技术栈、架构图(Mermaid)
- 快速开始 — 安装、配置、运行步骤
- API 参考 — 自动生成的接口文档
- 使用示例 — 常见场景的代码示例
- 常见问题 — FAQ 部分
输出格式
生成一个或多个 Markdown 文件,中文为主,技术术语保留英文。
技巧
- 优先读取已有 README、package.json、pyproject.toml 获取项目元信息
- 分析 import/require 语句推断依赖关系
- 从 docstring/JSDoc 提取已有文档
想直接用这个技能?
本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。