用途:在用户要求生成文档、写技术文档、生成 API 文档或项目说明时激活,从代码库自动产出中文技术文档。
主要能力:扫描项目结构并识别项目类型(Web 应用、CLI 工具、库或服务);分析代码,提取模块、函数、类、接口的签名和注释;生成项目概述(中文简介、技术栈、Mermaid 架构图)、快速开始(安装、配置、运行步骤)、API 参考(自动生成的接口文档)、使用示例(常见场景代码示例)和常见问题(FAQ)。输出为一个或多个 Markdown 文件,以中文为主,技术术语保留英文。
使用方式:优先读取已有 README、package.json、pyproject.toml 获取项目元信息;分析 import/require 语句推断依赖关系;从 docstring/JSDoc 提取已有文档。
限制:资料未提供安装命令、收费方式、支持语言范围与输出文件命名规则等细节;实际生成内容取决于代码库中已有的注释与元信息完整度。