技术文档、API规范与API定义：有什么区别？.docx

技术文档、API规范与API定义：有什么区别？

我最近在帮一个团队梳理他们的技术文档体系，发现很多人对文档、规范、定义这几个概念傻傻分不清。产品手册建设不是光写几页操作说明就完事，它涉及从设计到交付的全流程。用Baklib这样的工具，你可以把技术文档、API规范甚至自动生成的API引用整合到一个平台上，再通过多站点发布给不同的受众。回到正题，这篇文章就专门来讲清楚这三者的区别。

什么是技术文档

我们先来看普通开发者甚至最终用户最常遇到的概念：技术文档。本质上，技术文档是用户成功使用该技术所需的所有信息的总称。如果你现在想到代码片段或参数列表——那就对了。这些只是技术文档中常见的元素。现在，我们