@
shijingshijing #69
啊，我又来了，我还要补充几句，主要怪我眼神不好，没看到你把我关于软件文档的描述硬是要往 SDK 上做类比。
我啥时候提到过 SDK 了？嗯？
我甚至故意举了一个与软件开发无关的例子，我关于软件文档的例子用的是 ffmpeg，我指的官方文档是 ffmpeg 的命令行参数文档，这是个彻头彻尾的用户使用手册，哪来的 SDK ？
然而就是这么一份 FFMPEG 用户使用手册就已经算得上是“鸿篇巨制”了（对用户而言），且不说篇幅巨大，大到想用关键字搜都不能一下子定位到条目，更不用提这个软件很多特性很多规律甚至尚未被文档化，其中一小部分甚至连开发者自己都用不利索。用户社区内，大家既依赖这份官方文档，也同样依赖互联网上的笔记、问答来分享经验。“精通是不可能精通的，只有一边查文档一边开搜索引擎，日子才能过的下去这样子。”
至于 SDK 文档，你当世界上的 SDK 文档的体量和复杂度和细致度都一样哦？
写的细的软件文档在已经熟络整体的情况下是好事，因为知道怎么查，而且查的快，而且查到的很详细很准确，但是对刚上手的开发人员这就是噩梦；写的简略的文档则情况相反，刚上手时这是一份很好的指导手册，然而很多细节上面没有，得自己尝试或者询问他人。所以成熟的文档是既有巨量篇幅的细节与索引，又有一份面向新手的简介，实现过渡。然而这样的文档一般是成熟的框架、产品、平台的文档，这年头经常开发到一小半就拿出来用 /卖的东西太多了，文档只能逐步完善，这过程中还会有大改，等最后最终定型了，估计这套东西也快过时了。
但即使如此，无论是已经定型的，还是尚在发展的软件，不管是最终产品，还是用于开发的环境、框架、协议、平台，它们的文档论篇幅论复杂度都不会比硬件的文档简单。
你连手册里芯片有个变体这事都能拿上来专门讲一讲，干嘛，欺负这里硬件工程师少？
变体那么多，那是市场需求，客户需要，全写在手册上是尽本分，是为了用户能第一时间确定自己需要的元器件是什么型号、什么封装、什么包装，有些已经停产或者即将停产的用户还得考虑着手做新的替代设计。
有的产品变体能有十几二三十种，甚至更多，这么多变体难道都是给你一页一页慢慢翻看细细品味的？你要是已经定型了就赶紧找到对应的型号，该画封装画封装该画板子画板子。你要是还没选好型号赶紧和其他设计组多沟通赶紧把型号定下来，需要样品该申请就申请该买就赶紧买。
元器件数据手册里面的每项内容，就是这个元器件系列对外部（用户、开发人员）暴露出来的元素，这跟软件对外暴露出来的 API 是一个道理。变体、封装就是一个个列表，电热等物理特性就是元器件与外部环境交互的函数，额定参数是约束条件，管脚是输入输出的参量变量，设计原则是约束方法的函数，推荐方案相当于软件的示例代码，AN 相当于社区内关于问题的问答总结分享。
这不是一回事吗？
咋了，文档都是给人看的，都是为了说清楚事物的，在这两方面，难道硬件和软件有原则性区别吗？
最后模仿你的回复来回复你，这是我最喜欢的环节：
我只是看到你只懂这么几样拿来显摆就泼你冷水，从你回复我也能看出你是啥水平，不管去没去过大厂，终究学点皮毛，玻璃心和少见多怪都能从你的回复中看出来。软件的文档你最多也就知道个 SDK，毕竟我都拿非 SDK 的情况来举例了，你还是只会咬着 SDK 不放，黔驴技穷啊，呵呵。
就要跟你细说，少说一句算我输，你不看有的是别人看，你 B 了是你自己给自己关上一扇门。