软件行业从业人员如何写好文档？

       写软件行业的文档不是什么难事，不像我们语文的作文，要抒情，叙事，比喻，拟人，抖包袱。软件行业的文档是技术性质的，纯粹是把一件事情说清楚，说明文，因此只要我么会这个事，应该很容易写出这个文档。但我们很多人把程序都写了，但写出的文档却不堪入目。经过多年的锻炼和工作经验，我本人也算积累了一定的心得，写的文档也基本都能顺利过关。因此想在此分享下：如何写好文档这个题目。我主要从以下几点说明：

      首先，写好文档的前提是你主观上要“愿意”写这个文档。如果你不愿意写，那肯定是写不好的。第一步，我觉得应该正确地看待写文档这件事情。文档的作用。第一，于自己，是帮你理清思路，在头脑中重新演算下细节，确保从架构的高度分析，你即将编写的程序，或管理的项目，或做的设计是可行的，同时在开发阶段不用走弯路，提高开发的效率；第二，对于别人，也可以通过文档理解你的想法。第三，系统上线一段时间后，谁能保证不忘记当初复杂的逻辑和实施的细节，无论是自己还是个人，都可以通过文档，找回当初的细节，快速恢复记忆。以上三点，但凡有些工作经验的人，都应该有体会。因此文档不是白白浪费时间，文档的好处可以说是事半功倍的。既然很实用，和编程程序一样，就应该花时间去掌握。

     其次，写好文档是要像别人传递一种思想和想法，是正确的表达自己。表达自己有多种方式，有些人善言辞，通过语言打动别人；有些人肢体动作丰富，有些人文字能力较强。不同人其实有不同的长处，但每个人必须找到至少一种方式表达自己，否则只能生活在自己的世界中，也蛮惨的。比如很多人英语口语不行，但借助词典或翻译工作，写的还可以。这时候为了把一件事情说清楚你，你就可以先发邮件给别人，然后再打电话沟通，就很容易把事情说明白。从这个角度，说和写都是表达方式的一种，一些复杂纠结的事情，有时候还是需要通过“说”的方式来解决，但写本身，往往比说有着更高的沟通效率。因此，写好文档其实是提高表达能力的一种。

     以上从定位和态度角度说关于写问文档这件事情，但具体如何写好文档，也是有一些基本点和思路的，因此，第三点，我就说说写好文档的一些基本点：

     1） 文档基本格式要正确。文档的基本要求是字体统一且大小适中，且技术文档本身重要表达内容，不要太花哨。因此一些基本的Word的技巧还是需要掌握的。比如多级段落，页码，目录，封面，分页，页眉页脚，段落编号，对齐，粗体，排版等等。一个连基本格式都不具备的文档让人看起来很难受，且有时候会因此而停止阅读，这样即使文档的内容再好，也白白浪费了。我本人一般看到这样的文档，比如简历，或其它技术设计文档，就没有看下去的兴趣。我首先会认为“写文档的人水平很次，连基本的格式都搞不好，质量一定不怎么样。”其次，如果在一些正式场合，比如投标，客户也会认为态度上不重视，或不严肃。极大的影响表达的效果，有时候会适得其反。文档格式的练习其实很容易，有这么几次写好的经历，或严格模仿优秀的文档的排版几次，基本就会养成习惯。我个人体会，习惯一旦养成，格式不好就感觉不舒服。同时一但养成习惯，在写文档一开始就会把一些基本要素确定清楚，如页码，段落，排版等，后续就不用再花时间返工。因此建议有机会，找几个范文，模仿和琢磨下，看看别人都怎么写的。

     2) 其实写文档一定要模板吗？很多人写文档习惯性的找模板。模板固然可以节约上面格式的事情，但裁剪或调整中一些非必要的段落，也要花时间。且思路往往会受到已有断落的束缚，写出来文档可能就是为了表达而表达。写文档不就是把一件事情从头到尾，从框架到细节的说清楚吗，因此在写的时候，你头脑中应该有描述的思路-即段落了，否则你写不出太多东西。我本人有时候面试一些人的时候会问他们比如设计文档都包括那些章节，而不关心细节。如果思路清楚的人，很容易回答。但往往很多人回答不出来。比如你写一个项目需求规格说明书，就要从项目背景，名词解释，系统架构，网络架构，主要功能列表，详细功能，系统界面，业务逻辑，系统时间计划（这个也是项目执行的一部分）等方面去说明。如果你确实做过、思考过、主导过一个怎样去确认清楚一个软件项目的需求，必然对以上模块了然于胸。这就是章节，而如果你写不出，只能说明你没有或欠缺这方面的经验。

    （待续 )