美文网首页
如何提升编写文档的能力

如何提升编写文档的能力

作者: ajianggood | 来源:发表于2016-06-06 12:30 被阅读621次

在我身边的程序员中,无论是现在的同事还是过去的同事,普遍缺乏文档编写能力或能力严重不足,甚至有些编程能力很强的程序员也不能写出一篇可读性较强的设计说明书、产品手册等项目必备文档。其实,文档编写能力是成为优秀程序员和项目经理必须具备的能力,想要和更多人人进行交流只能通过你的文字来传达你的思想。该如何才能提高文档编写能力呢,可以采用了以下几种方法,只要坚持不懈的做下去,相信会有提高。

1、尝试编写个人简历和经历,用文字来认识自己是不错的方法。要想别人认识你,首先自己要认识自己。

2、养成良好的程序注释习惯,而且要用准确的语句描述注释的内容,从写注释的一句话开始锻炼文字表达能力。准确而简明的注释有助本人和他人阅读你的程序代码,语义不清或者错误的注释反而浪费了自己和他人的时间。

3、从编写较简单的文档(如:《XXX系统使用说明》)开始,锻炼文档编写的组织能力和文字表达能力

4、写博客。其实这也是我写博客的原因之一,想通过多写文章,用文字来准确的表达日常自己的所思所想来提高文档能力。还可以通过他人的评论和建议来改正不足之处。

5、阅读一些写作技巧方面的文章提升技术文档编写能力也是显而易见的。当然,要切实提高文档编写能力,需要勤于学习、勤于思考、勤于实践、长期积累,毕竟丰富知识和阅历才是写好文档的基础。

相关文章

  • 如何提升编写文档的能力

    在我身边的程序员中,无论是现在的同事还是过去的同事,普遍缺乏文档编写能力或能力严重不足,甚至有些编程能力很强的程序...

  • 接口文档的编写

    参考资料 如何优雅的格式化接口 如何优雅的“编写”api接口文档 接口文档的编写

  • 技术文档如何编写?

    关于文档编写的几个思维 近期重新组织了好几篇技术文档,把其中的一些感悟提炼出来。 文档为达到容易理解和操作的程度,...

  • 程序员的自我修养

    编写文档能力 PPT能力 演讲能力 说服他人的能力 GitHub,学会用Git来管理和分享你的代码 寿司之神-小野...

  • 《提升自己》连载07如何提升自己的学习能力

    《提升自己》连载06如何提升自己的学习能力 以下内容,承接上文!点击上面,完整阅读! 如何提升自己的学习能力 之 ...

  • 能力的有形化

    《你要如何衡量你的人生》 能力概念 读后感 “能力”的作用: 追求自我成长的关键之一是能力的提升,如何提升能力,...

  • 如何编写API接口文档

    当完成一个API接口时,通常需要与前端人员沟通接口的细节,这时候,一个文档就能节省很多效率,如何书写一份正确的AP...

  • 如何使用Markdown 编写文档

    Markdown 是一种轻量级标记语言,用来编写文本文档,一般后缀名为.md。该语言在 2004 由约翰·格鲁伯(...

  • 如何编写基于 Swagger-PHP 的 API 文档

    前言 编写目的 本文介绍如何使用Swagger编写API文档。通过阅读本文,你可以: 了解swagger是什么 掌...

  • 《提升自己》连载06如何提升自己的学习能力

    《提升自己》连载05如何由内而外提升自己的能力 以下内容,承接上文!点击上面,完整阅读! 如何提升自己的学习能力 ...

网友评论

      本文标题:如何提升编写文档的能力

      本文链接:https://www.haomeiwen.com/subject/lkordttx.html