(2)易用性:编制的各种软件文档,要便于不同的岗位人员进行阅读、理解、学习和使用。
(3)简洁性:要求软件项目中需要编写的文档内容突出主题,只反映要描述的问题,不包含其他不必要的东西,语言表达简明扼要,一清二楚,如有可能,可以配以适当的图表,以增强其清晰性。
(4)针对性:文档要按不同的类型、面对不同的对象,实行差异化编制,根据实际需要进行编写,也就是说文档编写目的要明确,因需而变。例如管理文档主要面向管理人员,用户文档主要面向用户,这两类文档不应像开发文档(面向开发人员)那样过多使用软件的专用术语。
(5)一致性:文档的行文应当十分确切,对于同一现象的描写,不能出现多义性的描述,同一项目中几个文档描述的内容应当是一致的,相互之间没有矛盾。
(6)完整性:任何一个文档都应当是完整的、独立的,没有遗漏和丢失的内容。也就是说每一种文档在设计时可以包含必要的图形、模型、叙述、表、索引、附录和参考文献,列举的这些内容都是完整的。同一软件项目涉及的几个文档之间可能存在部分内容相同,这种重复是必要的,不要在文档中出现“见XX文档XX章节”的现象。
(7)灵活性:在实际操作中要针对软件项目规模和复杂程度的不同,对现行的文档进行修正,决定编制的文档种类。可以依据自身软件开发情况,制定一个对文档编制的规定,用列表的形式列出在项目什么条件下,应该形成哪些文档,这些文档的详细程度。
(8)可追溯性:在软件项目的开发过程中,各个阶段编制的文档不是孤立的,而是与各个阶段完成的工作有密切的关系,随着项目开发工作的进展,具有一定的继承关系,体现出了可追溯的特性,如软件需求会在设计说明书、测试设计方案及用户手册中有所体现。
(9)设定优先级:在软件项目众多的文档中,其中一些文档必定是关键文档,起到非常重要的作用。对于这类文档要设定优先级别特别关注,不能有任何的错误存在,对于一些关键的地方要特别标记,特别说明。
6.文档的审核
审核就是检查编写的项目文档是否齐全有无遗漏,是否符合文档的规范要求,内容描写是否正确紧扣主题,列出的图表信息是否准确,以确保文档的质量。审核要花费一定的人力和时间,但效果是显著的。通过对文档进行全面的审核、充分的测试,有效地发现文档中存在的问题,如遗漏的需求、多余的功能设计内容、不切实际的测试计划、不可行的测试方案、不充分的测试案例和不合格的操作手册等,提前发现问题、改正问题。这样比客户使用软件时遇到麻烦或软件项目推广应用中出现问题时再向项目开发人员寻求支持更有效,且能提高客户的满意度,减少出错返工的成本和时间。
7.使用工具管理文档
对于一个大型的软件项目系统,从形成概念开始,经过设计、开发、推广使用和不断增补修订,直到最后被淘汰的整个项目生命周期中都要编写大量的文档。而文档编写的内容是在不断变化的,有的是连续的,承前启后的,有的是新增加的,也有的是废除的,如何管理好这些文档资料,为大家提供最新的信息,便于日常的调用查询,便于信息的利用,是发挥文档作用的重要一环,否则就是占用空间的垃圾。这就需要设计开发一个统一的软件文档管理工具,分门别类统一存放管理各种文档资料,建立软件文档资料信息库,供大家随时查询调用。
总之,文档在软件项目的开发过程中起到了关键的作用,从某种意义上来说,文档是软件项目开发规范的体现和指南,按照规范要求编制一整套文档的过程,就是按照开发规范完成一个软件项目开发的过程。高质量的文档可以提高软件项目的质量,有助于程序员编制程序,有助于管理人员监督和管理软件的开发,有助于用户更好地安装和使用软件系统,有助于维护人员进行有效的修改和扩充。所以,在软件项目的开发过程中,要充分做好软件文档的编制和管理工作。
文章来源于领测软件测试网 https://www.ltesting.net/