如何提高文档编写能力.pdf

如何提高文档编写能力

分享一篇博文如何提高文档编写能力

在我身边的程序员中，无论是现在的同事还是过去的同事，普遍缺乏文档编写

能力或能力严重不足，甚至有些编程能力很强的程序员也不能写出一篇可读性较

强的设计说明书、产品手册等项目必备文档。其实，文档如何才能提高文档编

写能力编写能力是成为优秀程序员和项目经理必须具备的能力，想要和更多人人

进行交流只能通过你的文字来传达你的思想。该如何才能提高文档编写能力呢，

可以采用了以下几种方法，只要坚持不懈的做下去，相信会有提高。

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

你，首先自己要认识自己。

2、养成良好的程序注释习惯，而且要用准确的语句描述注释的内容，从写注释

的一句话开始锻炼文字表达能力。准确而简明的注释有助本人和他人阅读你的程

序代码，语义不清或者错误的注释反而浪费了自己和他人的时间。

3、从编写较简单的文档（如：《XXX系统使用说明》）开始，锻炼文档编写的

组织能力和文字表达能力

4、写博客。其实这也是我写博客的原因之一，想通过多写文章，用文字来准确

的表达日常自己的所思所想来提高文档能力。还可以通过他人的评论和建议来改

正不足之处。

5、阅读书籍和文章时除了学习里面的知识和技术外，还可以研究研究作者是怎

么组织一篇文章和一本书籍的，通过怎样的一个内容结构来表达相关内容.

6、阅读一些写作技巧方面的文章提升技术文档编写能力也是显而易见的。

当然，要切实提高文档编写能力，需要勤于学习、勤于思考、勤于实践、长期积

累，毕竟丰富知识和阅历才是写好文档的基础。

/////////////////////////////////////////////////////////////////////

如果提高自己的文档书写能力，像技术方案，概要设计，建议书，PPT.对于一

个问题，我见过牛人，写了几十页来讲解，我却挤了很久才挤出几个字来。

按照重要程度和先后顺序相结合回答如下：

1，考虑听的人看得人需求在哪里，什么样的东西是他们需要的，他们想要什么？

比如你写一个方案给老板，就要从老板的角度考虑问题，是不是解决了他现在

碰到的问题，你提出的解决方案考虑了执行了没有，执行的成本分析了没有，

执行的过程中会碰到什么问题，执行中如何控制进度，执行后如何评估效果等

等。

不管是技术方案，概要设计，建议书，PPT都要首先严肃认真的考虑这个问题。

这一步特别的重要，当你站在自己的角度写出来的东西都是碰大运。

2，从这个思路开始，你要引入第一个工具，mindmap，如果你不熟悉，到维基

百科查阅，软件可以到各种下载站找，有很多免费的mindmap工具

首先要站在受众的角度列出核心的需要，然后分解出子需要，如果可能再分解，

然后针对每一个部分做出针对性描述和解决。

切记，受众已经知道的，千万不要写出来。

3，当你完成mindmap之后，要对行文的格式做一个初步了解

技术方案要重点探讨在原来基础上新增的部分，一定要针对新增的部分的先验

案例，不能让受众觉得有点悬不靠谱，可行性分析，解决方案，先验案例，费

用，执行日程，监控等等，叙述要完整，有头有尾。

建议书重点在出发点、过程概要性的描述，结果和效果，引用数据和来源要明

确，一切能够证明你的建议是对的东西都要明确罗列。

ppt一定要配合方案，只有ppt的方案都是空的。

概要设计最重要的是看你针对的是哪几种类型的受众，还是混合型的，要从设

计的核心开始讲起，逐步展开，在逻辑上要注意缜密、不要有明显的漏洞和遗

缺。

4，最后是写了，一定要用好word里大纲和格式这两个功能，如果不清楚，google

it。

在写的过程中我建议先根据前面几点所谈到的事项结合起来，先把提纲写好，

然后逐步添加内容，遇到不知道怎么添加的先放一下，把能写好的写完，然后

针对没有写的细节针对性的寻找解决的办法。

行文的风格要中性，严谨，形容词副词少用，多用定义明确的词汇和相当多的

专业词汇（根据受众而定），如果能用图表图片来表达的一定要优先使用。

千万不要从在某个地方停住，一定要从真个文档的角度从整体到细节的节奏来

完成。

5，最后是查漏补缺。

假设你讲完了，如果你是受众，你会提出什么问题？

把这些问题认真回答一下，放到对应的部分去。

//////////////////////////////////////////////////////////////////////////////////////////////////////

IBM文章：如何