软件文档写作技巧.pptVIP

5.7 软件文档的质量要求 一个好的文档资料能起到多种有益的作用。如，有助于系统顺利开发，有助于管理人员监督和管理软件开发，有助于用户了解软件的功能和正确操作流程，有助于维护人员进行有效的维护。 而一个质量差的软件文档，不仅使读者难以理解，给使用者造成许多不便，增加软件成本，甚至可能造成更加有害的后果。 因此，软件编档必须保证其质量。 造成软件文档质量不高的原因多种多样，但主要可以归纳为两条： 1. 缺乏实践经验，缺乏评价文档质量的标准； 2. 不重视文档工作，或是对编档工作安排不恰当。 最常见的就是，软件开发时不重视编档，最后却搞突击。;;5.8 软件文档编制技巧 拥有规范准确的软件文档，是每个软件产品保证质量所必须的必要条件，同时对软件企业自身非常有利，也能够让用户从中受益。而软件产品的正确使用，也依赖于文档的准确可靠。 那么，如何才能编制出好的文档呢？下面是一些建议： 1. 从技术角度进行文档的编制和评价 由于软件文档是作为软件产品的技术资料的特点，因此编制时应从技术角度着手，以忠实于技术事实为准绳，保证编制步骤、描述内容和使用图表资料的准确性。 2. 明确编档人员的责任 文档质量欠佳的主要原因之一就是责任不明确，没有承认编档人员的劳动付出。因此，明确责任，明确编档者的工作贡献，是提高文档质量的有效途径。