作为开发人员,提到写文档,比如需求说明、设计文档、接口文档和用户使用指导等文档时就比较头痛,写不好也不愿意写。
那到底有哪些原因让开发人员不愿意写文档呢?下面这个脑图列出了主要原因:
我们进行简单的分类,可以分为主观原因和客观原因:
主观原因
- 没有认识到写作的价值:梳理过程、总结经验、沉淀思想、提升技能。通过不断地梳理、总结、提炼,可以提升个人的技能,成为技术大牛,提升个人影响力。同时清晰的文档可以减少沟通成本,节省时间。你可不想在写代码的时候被人打扰吧?把文档丢过去,什么疑问都解决了。
- 不擅长写作,理工科的同学大部分不擅长写作,他们宁愿写代码也不愿写文档,看着优美的代码,满满的成就感,但是一到写文档就抓耳挠腮,写不出来或写不好。
客观原因
- 文档输出没有纳入考评要求
- 文档并非需求的交付件
- 缺少文档验收的标准
- 没有时间进行写作
了解了以上原因,我们就可以针对性地加以解决,各个击破。
本人在软件开发领域工作多年(十五年),既有专门的技术文档开发经验,也有还算丰富的代码开发经验,可以和各位开发同学有更多的共同语言,希望能够帮助大家提升技术文档的写作技能。在你成为业界技术大牛的道路上,我愿意助你一臂之力。
后面我会不断总结技术文档写作的方法,欢迎关注我!~~