配置管理与系统文档
配置管理是PMBOK、ISO9000和CMMI中的重要组成元素,它在产品开发的生命周期中提供了结构化、有序化、产品化的管理方法,是项目管理的基础工作。配置管理是通过技术和行政手段对产品及其开发过程和生命周期进行控制、规范的一系列措施和过程。信息系统开发过程中的变更,以及相应的返工会对产品的质量产生很大的影响。
产品配置是指一个产品在其生命局期各个阶段所产生的各种形式(机器可读或人工可读)和各种版本的文档、计算机程序、部件及数据的集合,该集合中的每一个元奈称为该产品配置中的一个“配置项”。
配置项主要有两大类,一是属于产品组成部分的工作成果,如需求文档、设计文档、源代码、测试用例等。二是属于项目管理和机构支撑过程域产生的文档,如工作计划、项目质量报告、项目跟踪报告等。这些文档虽然不是产品的组成部分,但是值得保存。
软件系统的文档可以分为用户文档和系统文档两类,用户文档主要描述系统功能和使用方法,并不关心这些功能是怎样类现的:系统文档描述系统设计、实现和测过等各方面的内容。
用户文档是用户了解系统的第1步,它可以让用户获得对系统的准确的初步印象,其中至少应该包括下述5个方面的内容。
(1)功能描述:说明系统能做什么。
(2)安装文档:说明怎样安装这个系统,以及怎样使系统适应特定的硬件配置。
(3)使用手册:简要说明如何着手使用这个系统(通过丰富的例子说明怎样使用常用的系统功能,并说明用户操作错误时怎样恢复和重新启动)。
(4)参考手册:详尽描述用户可以使用的所有系统设施,以及它们的使用方法,并解释系统可能产生的各种出错信息的含义(对参考手册最主要的要求是完整,因此通常使用形式化的描述技术)
(5)操作员指南(如果需要有系统操作员的话):说明操作员应如何处理使用中出现的各种情况。
系统文档指从问题定义、需求说明到验收测试计划这样一系列和系统实现有关的文档,描述系统设计、实现和测试的文档对于理解程序和维护程序来说是非常重要的。