配置及文档管理

配置管理

软件配置管理（SoftwareConfiguration Management， SCM）应运而生。其主要作用是通过结构化的、有序化的、产品化的管理软件工程的方法来维护产品的历史，鉴别和定位产品独有的版本，并在产品的开发和发布阶段控制变化；通过有序管理和减少重复性工作，配置管理保证了生产的质量和效率；它涵盖了软件生命周期的所有领域并影响所有数据和过程。

SCM 是指在软件系统中确定和定义构件（代码、可执行程序、文档等），在整个生命周期中控制发布和变更，记录和报告构件的状态和变更请求，并定义完整的、正确的系统构件的过程。

软件配置管理包括以下几个方面功能：

配置标识：产品的结构、产品的构件及其类型，为其分配唯一的标识符，并以某种形式提供 对它们的存取。

版本控制：通过建立产品基线，控制软件产品的发布和在整个软件生命周期中对软件产品的 修改。例如，它将解决哪些修改会在该产品的最新版本中实现的问题。

状态统计：记录并报告构件和修改请求的状态，并收集关于产品构件的重要统计信息。例如， 它将解决修改这个错误会影响多少个文件的问题。

审计和审查：确认产品的完整性并维护构件间的一致性，即确保产品是一个严格定义的构件 集合。

生产：对产品的生产进行优化管理。它将解决最新发布的产品应由哪些版本的文件和工具来 生成的问题。

过程管理：确保软件组织的规程、方针和软件周期得以正确贯彻执行。它将解决要交付给用 户的产品是否经过测试和质量检查的问题。

小组协作：控制开发统一产品的多个开发人员之间的协作。例如，它将解决是否所有本地程 序员所做的修改都已被加入新版本的产品中的问题。

两个文件都强调了配置管理三个核心部分：版本管理、问题跟踪和建立管理，其中版本管理是基础。

11、软件文档管理

文档常常是用来对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。

文档的归类 按照文档产生和使用的范围，软件文档大致可分为 3 类：开发文档；管理文档；产品文档。

（1）开发文档。开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细技术描述（程序逻辑、程序间相互关系、数据格式和存储等）。

（2）产品文档。产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。

产品文档主要应用于下列类型的读者： 用户——他们利用软件输入数据、检索信息和解决问题； 运行者——他们在计算机系统上运行软件； 维护人员——他们维护、增强或变更软件。

产品文档包括如下内容：用于管理者的指南和资料，他们监督软件的使用；宣传资料通告软件产品的可用性并详细说明它的功能、运行环境等；一般信息对任何对其感兴趣的人描述软件产品。基本的产品文档实物包括：培训手册；参考手册和用户指南；软件支持手册；产品手册和信息广告；维护修改建议等。

（3）管理文档。这种文档建立在项目管理信息的基础上，从管理的角度规定涉及软件生存的信息。它包括：项目开发计划、测试计划；开发过程的每个阶段的进度和进度变更的记录；软件变更情况的记录；相对于开发的判定记录；开发人员职责定义；测试报告、开发进度月报；项目开发总结等。

软件文档从用途上还可以分为内部文档和外部文档。其中，

内部文档包括项目开发计划、需求分析、架构设计说明、详细设计说明、构件索引、构件成分说明、构件接口及调用说明、构件索引、构件接口及调用说明、类索引、类属性及方法说明、测试报告、测试统计报告、质量监督报告、源代码、文档分类版本索引和软件安装打包文件等。 外部文档主要包括软件安装手册、软件操作手册、在线帮助、系统性能指标报告和系统操作索引等。