用途:为不同读者和场景撰写清晰、可维护的技术文档。触发方式包括“write docs for”“document this”“create a README”“write a runbook”“onboarding guide”等。
主要能力(文档类型):
- README:说明项目是什么、为何存在,快速上手(5 分钟内首次成功)、配置与用法、贡献指南。
- API 文档:端点参考与请求/响应示例、认证与错误码、速率限制与分页、SDK 示例。
- Runbook:何时使用、前置条件与所需权限、分步操作流程、回滚步骤、升级路径。
- 架构文档:背景与目标、高层设计与图示、关键决策与权衡、数据流与集成点。
- 上手指南:环境搭建、关键系统及其连接方式、常见任务演练、问题该找谁。
原则:面向读者思考其需求;先给最有用的信息;用代码、命令、截图展示而非空谈;保持内容最新(过时文档比没有更糟);引用而非复制其他文档。
限制:资料未提供具体安装命令、平台支持、收费方式或使用步骤细节。