为什么开发给的接口文档总是不能用？

首先我是一个”文档无用论”的支持者。

相信大部分开发，测试人员都有一个感触：开发给的接口文档十有八九不能用。

难道开发人员就不能给一个准确的接口文档吗？

答案是：真得很难。

这是由于目前的开发流程以及开发人员习惯所决定的。大部份的接口文档起草于接口最早开发时，但是随着开发过程，接口代码经过几版迭代，文档就会落后于代码。因为：

没有开发人员会在改完代码后立即更新接口文档
当有人员需要接口文档时，没有开发人员会检查文档是不是跟代码一致

所以，当拿到一个格式良好，很正式的接口文档时，就要小心了：这十有八九是个旧文档。反而，没有格式的文档可能是最新的，因为这可能是开发人员现写的。

blog comments powered by Disqus