用途:帮助创建、维护和改进各类技术文档,适用于新项目文档、README 更新、API 与函数说明、用户指南、架构决策记录以及代码注释完善。
主要能力:
- API 文档:REST 端点、参数、响应、示例、认证、错误处理;函数/方法参数、返回值、异常;类型定义。
- README:项目概述、安装、快速开始、用法示例、配置、贡献指南、许可证。
- 代码文档:Python docstring(Google 风格)、JSDoc、Javadoc、类型提示与复杂逻辑注释。
- 架构文档:组件关系图、ADR、数据流、技术栈、部署说明。
- 用户指南:入门、教程、操作指南、参考、故障排查。
使用方式:先读取现有代码与项目结构,识别文档需求,再按语言约定生成对应格式,并附示例与交叉引用。资料给出四类工作流:生成 API 文档、从项目创建 README、记录架构、改进代码注释。
支持格式与工具:Markdown、reStructuredText、AsciiDoc、OpenAPI/Swagger、GraphQL Schema;生成器包括 Sphinx、JSDoc、Javadoc、GoDoc、Rustdoc、Swagger/OpenAPI、MkDocs。
限制:资料未提供具体安装命令、收费方式、平台支持或效果数据;示例代码仅作格式参考,实际使用需结合项目情况。