文档,不仅仅是文档。

有感而发,谈点感受。关于接口对接开发 及  接口文档。区域化、多平台、多产品在一个项目并存已经是常态,以后会愈演愈烈,势必存在N多接口对接,对于初次接触某个产品的同事来说,本身对产品不熟悉,产品与产品之间的互联互通、传输流程,也是更加不清楚。看了接口文档,一下子看不明白也算正常现象。我们要尽可能把接口文档、各种产品文档写清晰,把流程、交易讲清楚,举个不恰当的例子:我们是高中生,读者是小学生,我们该把文档写成 让 小学生也能看懂,才是传道受业解惑。

原文地址:https://www.cnblogs.com/JercanYu/p/14315964.html