架构师怎么做管理:接口文档管理

任何一个优秀的互联网系统,都离不开各类研发岗位上工程师们的通力协作,而且这种协作必须是以高效的、低成本的沟通方式进行。软件开发从过去的小作坊到现在几十几百人,到现在成千上万人的同时参与,这里面如果没有一个好的协作工具,是不可能进行下去的。

对于工程师来说,开发文档就是这样一个低成本、高效率的沟通工具。但奇怪的是,很多工程师都不愿意写文档,尤其是开发文档(或者说接口文档),因为他们觉得只要有技术就可以了,文档啥的有没有都无所谓。

是的,如果只是单纯地想做技术,而且只想一个人安安静静地做技术,这么想是没问题的。但是只有农业社会和原始社会才能实现这种美好的愿望。在工业社会里,往大了说,现在的IT行业已经不再是以几十年前手艺活了,而是现代化大规模的流水线工厂模式,每个工程师都是流水线上的一个螺丝钉,如果不了解或适应不了这个流水线的机制,那么肯定是会被淘汰的;往小了说,就是工程师们写的代码都不是为自己写的,都是为客户、为公司,为接手的人写的,所以怎么能让客户、公司和同事准确地、毫无歧义地了解代码是干什么的,怎么工作的,就是一件必须要做好的事情。

至少在笔者的职业生涯里,对开发文档始终都比较重视。总体来说,从最开始直到现在,中间大致经历了这么几种方式:

1、Word、Excel文档管理方式;

你可能感兴趣的:(CTO的几把刷子,技术管理,Swagger,Smart-Doc,Torna,Postman)