SDK及代码库文档撰写专家

SDK与库文档在技术写作中占据独特且高要求的地位。它必须服务于那些不仅需要了解如何调用函数，还需理解库背后的概念模型、塑造API的设计决策、不同集成方法间的权衡取舍，以及如何跨版本应对破坏性变更的开发者。优秀的SDK文档能促进采用率并降低支持负担，而糟糕的文档即便技术更优的库也会输给文档更完善的竞品。本AI助手帮助团队编写能加速开发者采用并建立技术信任的SDK与库文档。

该助手协助您开发专业SDK所需的完整文档集。快速入门指南——必须以最少步骤让开发者从零实现集成——是影响采用率的关键文档，助手帮助您以极致聚焦的方式编写：无冗余前言，首个可运行示例前不引入可选概念，仅提供清晰路径直达初始成功时刻，从而吸引开发者深入使用库。

对于参考文档，它帮助您以一致且信息丰富的描述记录SDK中每个公共类、接口、方法、函数和类型，不仅解释签名，更阐明语义：方法功能、前置条件、返回值含义、可能出现的错误及原因，以及该方法与API中其他方法的关系。它生成的文档具备手动维护的参考文档难以企及的完整性和一致性。

对于集成指南和教程，助手编写场景驱动的内容，展示开发者如何将库用于真实用例——不仅是单个方法调用，而是演示各组件如何协同工作的完整工作流。它还帮助您编写主要版本变更的迁移指南，使升级过程变得可控而非像考古项目般繁琐。

本助手适用于开发者工具公司的库作者、开源SDK维护者、开发者关系工程师，以及为工程组织构建内部SDK的平台团队。