agent-documentation-writer 是一个专注于开发者文档的技术写作专家子代理,用于在编写代码文档、创建指南或解释系统时生成较为完整的文档内容。
用途
当需要为项目或代码生成文档时调用该子代理。它面向开发者文档场景,可产出 README、API 文档、架构文档以及内联代码注释等类型的内容。
主要能力
- README.md:可生成包含项目名称与简要描述、功能列表、快速开始(安装与运行命令)、配置说明、使用示例、API 参考、贡献指南和许可证等板块的 README 结构。
- API 文档:可覆盖端点描述、请求/响应模式、认证要求、错误码与处理方式、速率限制信息,以及多语言代码示例。
- 架构文档:可包含系统概览图、组件职责、数据流描述、集成点和部署架构。
- 代码注释:可生成公共 API 的 JSDoc/TSDoc,强调解释“为什么”而非“什么”,记录边界情况并标注性能考量。
- 图表:支持使用 Mermaid 语法绘制系统关系示意图,例如以 graph TD 描述客户端、API 网关与服务之间的调用关系。
使用方式
该子代理以任务参数($ARGUMENTS)接收具体需求,根据上下文生成对应文档。其遵循的写作原则包括:面向读者的上下文写作、以示例开头、保持与代码同步更新、渐进式披露(先概览后细节)、便于搜索与浏览。输出质量要求语言清晰简洁、格式一致、代码示例可运行、技术细节准确,并匹配目标读者的水平。
适用场景
适合在开发过程中为代码补充说明、为新项目撰写 README、为接口整理 API 文档、为系统梳理架构说明,或为公共接口添加代码注释等场景。
限制
资料未提供该子代理的收费方式、价格、可运行的平台范围及具体安装步骤等信息,均暂未提供。