zh-docgen
Skill907 starsChanged 5 months agoMITView on GitHub
中文文档生成器 - 从代码库自动生成中文技术文档
In this repository20 other files it gives its agents.
- docs/llms.txtllms.txt
- api-testerSkill
- changelog-genSkill
- db-migratorSkill
- dep-auditorSkill
- ds-mapperSkill
- env-managerSkill
- error-translatorSkill
- eslint-fixSkill
- github-actions-genSkill
- git-workflowSkill
- i18n-helperSkill
- log-analyzerSkill
- perf-profilerSkill
- refactor-advisorSkill
- security-auditSkill
- skill-curatorSkill
- test-generatorSkill
- zh-code-reviewerSkill
- zh-readmeSkill
The file
Files
中文文档生成器
触发条件
当用户要求生成文档、写技术文档、生成 API 文档、项目说明时激活此技能。
工作流程
- 扫描项目结构 — 识别项目类型（Web 应用/CLI 工具/库/服务）
- 分析代码 — 提取模块、函数、类、接口的签名和注释
- 生成文档 — 输出以下文档：
生成内容
- 项目概述 — 中文简介、技术栈、架构图（Mermaid）
- 快速开始 — 安装、配置、运行步骤
- API 参考 — 自动生成的接口文档
- 使用示例 — 常见场景的代码示例
- 常见问题 — FAQ 部分
输出格式
生成一个或多个 Markdown 文件，中文为主，技术术语保留英文。
技巧
- 优先读取已有 README、package.json、pyproject.toml 获取项目元信息
- 分析 import/require 语句推断依赖关系
- 从 docstring/JSDoc 提取已有文档
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.