为什么程序员不愿意写 API 文档了？有什么好工具推荐么？

一、程序员为什么不爱写文档？是他们变懒了吗？

其实大多数程序员都不爱写文档，为什么呢？

我觉得可以从两个方面去拆解：客观原因、主观原因。

1. 客观 - 时间紧任务重，需求变化快

需求方一般都是紧急需求，老板每次都要求敏捷开发，快速响应。按时交付的压力已经让大多数程序员不堪重负，更别提写代码的同时同步维护文档了。而不写文档呢，或者糊弄写写文档又不影响绝对重要的开发进度。尤其在互联网公司，需求变化非常快，代码不停地迭代，文档如果不及更新的话，和实际代码差异很大。

2. 主观 - 缺乏经验，写作困难

正是由于长期不写文档或者随便一些，当需要去写的时候，发现无从下笔，写作可太难了!!!

而接口文档的要求相对来说较高，不仅需要内容详实，把问题描述清楚，还需要有清晰的层级结构，让其他读者快速获取到有用的信息，这对经常写代码缺乏文档经验的程序员来说，本身也是一项挑战。

二、写 API 文档这么麻烦，那到底写不写了？

对于写 API 文档这件事情来说，往往短期高估文档的重要性，长期低估文档的重要性。短期以项目按时交付为主，项目细节也都还烂熟于心，但是长期来说，随着大脑的记忆内存被逐渐回收，当再次迭代之前的代码时，甚至有人员变更时，缺乏文档的部分往往成为黑盒子，与其花大量时间去探索解密别人的代码，还不如整体重构来得快！

于是，我们似乎陷入了工作永远做不完的怪圈：

针对 API 文档这个老问题，我这里推荐一个款开源的 API 管理工具，有 API 相关的核心功能，叫 Eoapi

Eoapi 是一个可扩展的 API 工具平台。

Eoapi 集合基础的 API 管理和测试功能，并且可以通过插件简化你的 API 开发工作，让你可以更快更好地创建 API。

Demo 链接：

www.eoapi.io/?utm_source=sf&utm_campaign=xh&utm_content=wendang

不妨自己试试，你绝对会喜欢这个叫 Eoapi 的开源 API 管理工具

github 地址：
https://github.com/eolinker/e...