共计 830 个字符，预计需要花费 3 分钟才能阅读完成。
一、程序员为什么不爱写文档？是他们变懒了吗？
其实大多数程序员都不爱写文档，为什么呢？
我感觉能够从两个方面去拆解：客观原因、主观原因。
- 主观 – 工夫紧工作重，需要变动快
需求方个别都是紧急需要，老板每次都要求麻利开发，疾速响应。按时交付的压力曾经让大多数程序员不堪重负，更别提写代码的同时同步保护文档了。而不写文档呢，或者糊弄写写文档又不影响相对重要的开发进度。尤其在互联网公司，需要变动十分快，代码不停地迭代，文档如果不迭更新的话，和理论代码差别很大。
- 主观 – 缺乏经验，写作艰难
正是因为长期不写文档或者轻易一些，当须要去写的时候，发现无从下笔，写作可太难了!!!
而接口文档的要求相对来说较高，不仅须要内容详实，把问题形容分明，还须要有清晰的层级构造，让其余读者疾速获取到有用的信息，这对常常写代码不足文档教训的程序员来说，自身也是一项挑战。
二、写 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…