- 本文原创作者：谷哥的小弟
- 作者博客地址：http://blog.csdn.net/lfdfhl
- 本文参考资料：电子工业出版社《软件文档写作教程》 马平，黄冬梅编著
必备条件概述
软件系统配备软件文档不仅对于公司非常有益，而且也能够让客户从中受益。由于软件产品如何使用在某种程度上是要依赖软件文档来进行说明的，因此软件文档必须准确可靠。使用不准确的和已经过时的软件文档对于公司的发展也会产生一定的阻碍，同样也会对客户产生消极的影响。一旦客户发现在他们使用产品的时候遇到了问题，却不能通过求助于伴随软件产品的软件文档的手段进行解决的时候，客户就会对这种软件产品产生怀疑乃至于失去信心，公司的信誉和利益自然而然地就会受到损害。
无论是面向客户的需求分析书、用户手册，还是面向开发者的概要设计书、详细设计书、测试计划书，既然都是软件开发中产生的软件文档，则它们都具有一定的共性，都必须具有完整性、准确性、易用性和及时性。
完整性
大多数客户在刚开始使用一个新软件系统的时候，最快的入门方法就是软件的开发方派出技术人员对客户进行系统培训，通过从头到尾的演示过程，手把手地教会客户该软件的使用方法，并且及时的回答客户的提问。这样的培训无疑是快捷而有效的。但是，对于大型的软件系统而言，其客户数量也是巨大的，不可能让所有的客户都停下手中的工作参与到软件的使用培训中去。通常只会选择让客户经理去参加，然后由客户经理再往下推广。这样的推广模式，首先不能保证直接参加软件使用培训的客户经理能充分的理解软件的使用方法。其次，客户经理在向下进行推广的时候，不能保证他们所说的都能完全符合该软件系统的实际情况。最后，最终用户怀疑自己理解的东西到底是不是开发方想传达的东西。只要传播的环节增加，讹传的可能性就会增加。如何才能判断自己理解的东西是不是正确的东西呢？依据就是软件文档。无论是直接得到软件开发方培训的客户经理还是经由若干级传播之后的最终用户，他们看到的都是同一份软件文档。通过阅读相同的软件文档，不同用户之间的理解不会有太大的差异。而且将软件文档发送给最终用户让其自行阅读，比一级一级进行培训可以节约大量时间和成本。
软件文档的作用是指导开发工作的进行，软件文档的内容应该是完整的。具体工作的展开都是基于软件文档的内容，软件文档记述了做什么，如何做等问题。软件文档就像小说一样，有头没尾、故事情节不完整的话，无法称其为一部完整的小说。每一阶段的软件文档必须为下一阶段的工作提供必要的信息，这样才能让软件开发工作如流水般顺利地进行下去。
准确性
软件工程是一门工程学，它具备严谨、准确的特点。将这门学科运用到实际的软件开发工作中去，就要求软件开发的过程也必须是严谨而准确的。应用到软件文档的编写中就是，文字表述要明确，逻辑要清晰，不能出现含糊其辞的句子，不能提供多种方案供参考，文档中只能出现充分思考权衡之后的最终实现方案。这样的文档，才不会造成阅读者的歧义，不能像阅读文学作品那样，仁者见仁智者见智，十个人读完之后有十种不同的感受。软件文档必须让每个人读起来得到的结论是一样的。
易用性
如果一套软件具备功能强大，界面美观，性能优良等优点，唯独操作过于复杂，这样的软件不容易得到推广。相反在实现相同功能的前提下，操作简单的软件容易被客户接受。软件文档也是一样的，必须具有易用性。软件文档的易用性是指易于查找，当客户想了解软件某方面内容的时候，必须很容易的知道在什么地方能获得自己想知道的内容，不能将时间花费在寻找上。
及时性
从决定开发一套软件系统开始，时刻都有变化的可能性，唯一不变的就是变更本身。前期终于和客户沟通完毕，形成了详尽的需求分析书，软件开发人员甚至已经开始着手设计该系统，即使是这个时候，也可能经常会收到来自客户的需求变更，于是需求分析书需要重新修改，按照需求变更的影响范围，概要设计书也必须相应地进行修正。经过一段时间的修改，概要设计书终于完成，进入了子系统和功能模块的详细设计阶段。但是，这时又可能发现之前的概要设计书某些方面不够合理，某些子系统的设计过于复杂，子系统间耦合度过高等问题，导致概要设计书的再次修改。随着每一次的软件文档修正，都会产生一个新的软件文档版本，我们必须保证的是，软件开发人员的工作必须是建立在最新软件文档的基础上，避免因为软件文档的版本问题导致返工。
所以，任何软件文档都必须及时地反映开发过程中的变更，并且及时地反馈到软件开发的相关人员手中。
