编写 SDK 说明文档的重要性不言而喻，但怎么写得快、写得好却是一门学问。

为此，我整理了工作中写过的 SDK 说明文档，总结形成一份模板。

前置说明

• 本模板仅提供文档结构，不涉及具体的文档形式（如 doc 文档、HTML 文档等）

模板 SOP

1. 更新历史：提供版本号或发版时间维度的更新说明，具体维度选择与产品形态相关。当「更新历史」内容较多时，可单开文档并链接地址至本处。需要充分运用 CHANGELOG 自动生成技术
2. SDK 总览：描述 SDK 功能，并使用表格展示 各种编程语言和环境 的 SDK 说明、下载地址和相关文档
3. 快速入门：简单描述 SDK 使用的前置条件（环境要求等）和流程步骤。流程步骤包含：配置开发环境、集成 SDK、初始化 SDK、使用 SDK，如上每个步骤说明需要链接索引至文档位置。
4. 配置开发环境：介绍开发环境配置包含的内容，比如系统版本、前置安装软件版本等软硬件要求
5. 集成 SDK：介绍 SDK 的集成方式和具体步骤
6. 初始化 SDK：介绍 SDK 的初始化方式和具体步骤。
7. 使用 SDK：简要介绍如何使用 SDK 以及目的
8. SDK API 参考：提供所有 API 的说明及索引。按类划分，并使用表格结构维护。
9. 常见问题：维护 SDK 使用时的常见问题。每个小节以「问题描述」作为标题，如有必要则在下方进一步补充描述，最后给出解决方案

具体模板

不在此文档维护，详情参考飞书文档 (opens new window)