Question

如何提升文档编写能力

Answer 1

在我身边的程序员中，无论是现在的同事还是过去的同事，普遍缺乏文档编写能力或能力严重不足，甚至有些编程能力很强的程序员也不能写出一篇可读性较强的设计说明书、产品手册等项目必备文档。其实，文档编写能力是成为优秀程序员和项目经理必须具备的能力，想要和更多人人进行交流只能通过你的文字来传达你的思想。该如何才能提高文档编写能力呢，可以采用了以下几种方法，只要坚持不懈的做下去，相信会有提高。 1、尝试编写个人简历和经历，用文字来认识自己是不错的方法。要想别人认识你，首先自己要认识自己。 2、养成良好的程序注释习惯，而且要用准确的语句描述注释的内容，从写注释的一句话开始锻炼文字表达能力。准确而简明的注释有助本人和他人阅读你的程序代码，语义不清或者错误的注释反而浪费了自己和他人的时间。 3、从编写较简单的文档（如：《XXX系统使用说明》）开始，锻炼文档编写的组织能力和文字表达能力 4、写博客。其实这也是我写博客的原因之一，想通过多写文章，用文字来准确的表达日常自己的所思所想来提高文档能力。还可以通过他人的评论和建议来改正不足之处。 6、阅读一些写作技巧方面的文章提升技术文档编写能力也是显而易见的。 当然，要切实提高文档编写能力，需要勤于学习、勤于思考、勤于实践、长期积累，毕竟丰富知识和阅历才是写好文档的基础。