软件文档写作09-文档管理.pptVIP

第九讲 软件文档管理 * 在软件生命周期内，由于项目开发过程的复杂性、多方人员参加以及时间跨度较长等因素的存在，软件文档作为记载“软件历史”的载体，记载了所有与软件有关的需求、建议、方案、结论和过程等，是保证开发任务之间联系的凭证和管理依据，也是保证软件正常运行和维护支持的基础支撑。 因此，软件文档的专业化、标准化和规范管理，是整个项目管理中不可忽视的重要组成。 1. 软件文档管理 文档管理的目的是使文档能够发挥其应该发挥的作用。因此，文档管理工作应该贯穿软件生命周期的全过程。软件文档的管理过程分为4个部分，如右图所示。 随着软件工程化方法的不断普及，软件文档管理已经逐步取代数据管理，而成为软件开发的中心。CASE工具中，对文档的支持也已经成为开发平台的一个基本配置。 随着多媒体技术的发展，文档的内容也从简单的文本发展到集文字、图形、图像、表格、声音、流程图等各种复杂对象的集合。 文档的形成 标识文档类型 文档的控制 文档的修改管理 * ① 文档的形成 软件项目的每个参与者，尤其是项目负责人，应该明确文档是软件产品不可缺少的重要组成部分。软件开发各个阶段文档按期保质的完成，是该阶段工作正式完成的有形标志。文档的形成过程必须严格按照规定进行，把好编制、评审、版本管理等环节，以保证文档质量。文档形成过程如图所示。 * ② 文档的分类和标识 在软件开发过程中，会有各种不同类型的文档，从各个不同岗位的人员手中产生。为了便于保存、查找、使用和修改，需要对文档进行结构化、分层次的组织和管理。 通常，对文档的标识方法由软件开发企业自己完成，使文档的每一页都有明确的标识。例如，可以按以下4个层次对文档加以分类和标识： - 文档所属项目的标识 - 文档种类的标识。如按软件文档的编制形式或按软件功能进行分类 - 同一文档的不同版本号 - 文档的性质、保密级别和可供借阅的范围等 * ③ 软件文档的管理和控制 随着项目进程的深入，软件文档的数量、种类和使用的场合等也在不断的增加，因此，必须对文档加以周密的管理和控制，以保持文档与产品的一致性，保持各种文档之间的一致性，保证文档各个版本之间的有序性，保证文档的安全性。这样的管理和控制可以表现为以下几个方面： - 项目组设置专职文档管理员，集中保管文档 - 所有保管文档均应有编制人、审核人、批准人和保管人的签字 - 保管的文档应确保安全。通常保存内容完全一致的2套，其中一套可出借 - 保管文档的出借应按照规定的文档涉众范围，办理借阅手续，按时归还 - 项目组成员自己的文档自己保管，但应按时提交，并确保内容的一致性 - 为确保项目及文档安全，项目组所有成员不得持有完整文档 - 及时反映文档版本更新，注销并封存旧版本 - 项目将结束时，文档保管员应及时收拢散存的文档，检查内容，确保完整 * ④ 文档的修改管理 在项目开发过程的任何时刻，都会有项目组成员以种种理由对文档进行修改。文档修改所带来的影响可能很小，也可能会牵涉许多方面。因此，文档修改必须谨慎，文档修改活动必须严加管理，文档修改过程必须严格遵守相关规程，使整个文档修改活动都能有序受控的进行。 具体的文档修改活动大致可以分为以下5个步骤： - 建议。项目组任何成员都可以提出修改建议，并提交修改建议表，说明修改理由、内容和涉及的文档及部位 - 评议。文档修改建议应经过评议方可实施。评议内容包括建议的有效性，修改的必要性，确定修改的范围，研究修改的方法、步骤和实施计划 - 审核。审核包括核实修改建议包含的内容，核实修改活动将带来的影响，审核修改活动计划的可行性。审核工作通常由项目负责人承担 - 批准。由开发单位的相关部门负责人批准。批准时，应确认修改活动的内容、计划、责任人和完成日期，以保证不影响整个项目的进程 - 实施。由修改责任人按修改计划承担具体的修改任务，完成后交文档管理员归档，并分发给有关持有者。 * 2. 软件文档的管理方式 合理有效的管理已经形成的软件文档，是加强软件开发过程管理，提高软件产品质量，持续改进开发组织过程能力的重要问题。 软件文档的管理，可以从技术角度和管理角度提出和形成各自有效的管理方法。 从技术角度，文档的管理维护有两种方式： - 采用手工、静态的管理方式。该方法在编档、整理及修订时，手工作业，劳动强度大，应用时有较大局限 - 采用新方法、新工具。如CASE、软件集成、动态管理、自动代码生成、万能查询系统等。这类方法和工具虽然需要有一定的投入，但对项目开发带来的持续效益巨大。 从管理角度看，文档管理和系统管理的方式是密切相关的