sdk文档书写，如何写具有可读性和可信度的文档

1.首要注意：文档的可信度非常重要，日常的代码工作需要围绕着文档进行和体现。

一篇好的文档应该包含需求、设计目标、系统架构、模块简介、潜在风险等方面，在写作上又应该遵循以下要点：

• 尽可能保持简单；

• 添加图表以可视化；

• 包含数字更为具体；

• 一定的趣味性让文档更耐读；

• 做好自审，以评审者的角度去看文档；

• 假期测试，看其他人能否读懂、实现；

• 流程环节完备，关键人物参与其中；

sdk开发经验总结_我是黄大仙的博客-CSDN博客

SDK 开发之文档 - 简书 (jianshu.com)

优秀实例

微信平台的作品

1. 微信公众号

微信网页开发 / JS-SDK说明文档 (qq.com)

2. 微信小程序

基础 | 微信开放文档 (qq.com)

aws亚马逊的文档示例：

AWS 一般参考 - AWS 一般参考 (amazon.com)

英文介绍：

Why These API Docs are Better Than Yours (And What You Can Do About it) (readme.com)

大厂文档规范：

qiuxr/Qcloud: 腾讯云文档规范 (github.com)

SDK设计指南/注意事项

手把手第二篇：如何设计 SDK - 知乎 (zhihu.com)