探讨为确保软件外包项目的质量如何实现文档的规范化.docVIP

探讨为确保软件外包项目的质量如何实现文档的规范化 摘 要：软件文档的质量是软件项目质量的一部分，规范的过程管理包括软件开发过程的文档，其规范及标准化便于开发过程中准确地交流信息以及软件项目交付后的维护工作，因此可以提高软件开发的效率和质量、改进软件开发的过程。本文依据项目的实践经验，探讨如何实现开发文档的规范化。指出文档规范化的重要性，并且有效地控制变更并对应修改开发用的文档即始终保证文档与代码的一致性在软件项目交付使用后的版本升级及信息系统维护中更具重要性。 关键词：软件开发文档；项目质量；Offshore；概要设计；详细设计；文档规范化；软件开发文档标准化 中图分类号：TP311.5 1 软件开发文档的重要性 影响软件项目进度、成本、质量的因素主要是“过程、人、技术”[1]。而规范的过程管理，包括软件开发过程的文档规范及标准化便于开发过程中准确地交流信息以及软件项目交付后的维护工作，因此可以提高软件开发的效率和质量、改进软件开发过程。 文档既然是多人进行项目开发相互沟通及共享信息的媒体，它就是项目所必须的、可重用的、文档的质量也是评价项目质量的一部分，而且最重要的是文档是否与源代码保持一致很重要。 软件项目的开发是个团队化作业复杂的过程，团队成员间的沟通很重要。目前软件开发项目面临的挑战是：很多的软件开发环境，应用平台也很复杂，有的需求又要在多语言环境下运行。因此保证软件项目成功的较为重要的一个因数之一是软件开发过程及其文档的规范化管理。文档是软件产品的一部分，文档在软件设计人员、软件开发人员、软件维护人员及用户之间起到桥梁的作用。特别是外包开发的过程中设计人员与编程人员往往不在一个办公地点，对系统功能要求的理解除电视会议，聊天工具，电话等语言视频沟通外，文档的沟通很重要，按规范制作文档的过程也就是按照软件开发的规范编制软件的过程。 既然文档在设计及开发的过程中能在多人多种角色间起到桥梁的作用外，它的编制就必须有助于程序员在编程前能够理解设计书定义的功能定义，有助于项目管理人员监督和管理软件的开发过程。此外，产品交付后要有助于用户了解软件的工作和操作，有助于系统维护人员对系统软件进行有效的维护、修改和功能追加，因此文档的编制不仅非常重要还必须要保证一定的质量。 2 软件开发文档 软件开发文档的种类很多。主要有：功能要求，需求分析，概要设计，详细设计，软件测试计划，软件测试报告，软件用户手册，数据库设计，项目可行性分析，项目计划，问题管理，项目进度管理，项目总结等许多文档。软件开发规范（GB 8566-88），软件产品开发文件编制指南（GB 8567-88）。 如下开发工程阶段需要的文档（见表1）： 表1 软件开发工程阶段的文档示例 概要设计 详细设计 单元测试 集成测试 系统测试 软件交付 概要设计说明书 详细设计书 单元测试计划 集成测试设计书 系统测试计划 用户安装手册 DB设计说明书 单元测试报告 集成测试报告 系统测试报告 用户使用指南 3 设计书样式 3.1 用什么文档编辑软件书写设计书。发达国家的软件业很重视文档，尽管目前敏捷开发被一切企业和开发团队所接受，但不可否认，对需求相对明确，离岸的开发方式下，大部分的项目目前还是较多地采用瀑布式的开发方式。 实践证明，用Excel书写设计书比用Word书写更加灵活和高效。本人参与开发的项目中，绝大部分设计书都是用Excel书写的，Excel特别适用于图形及表格的表达方式。而且项目的经验是尽量使用图形及表格的方式来记述设计定义，沟通理解的准确率较高。 3.2 文档的结构、语言表述及术语。文档结构的装订顺序为封面、修正履历、正文、附录说明。文档中的层次番号也要统一，清晰的层次便于阅读。语言的表达方式在外包的开发方式中很重要，因设计人员与开发人员通常不在一个办公地点。特别是离岸外包的方式，设计人员与开发人员是不同的母语。因此设计书的语言描述应尽量使用简单句型，不要使用双重否定，语言描述要清晰准确尽量不要有二义性。事实上开发中出现的错误在一定比例上是由于设计书的理解错误所造成的。因此语言的表达应尽量使用数学逻辑符号，因为只有数学符号是跨不同语言的，不易产生理解错误。如下（见表2）。实践证明，仅用语言来表达，往往易产生理解错误，用数学符号及数学逻辑符号的沟通最准确。此外在图形或表格旁同时追记语言描述比单单仅用语言来描述其沟通效率更高。 表2 数学表达示例 数学表达 A≠zero and A≠space B 0 and C 0 D zero or D space X?0 日付?yyyy0401 术语的标准化可提高沟通准确度和效率的同时还能提高书写详细设计及测试报告书的文档质量。因为在外包开发中，不能保证所有参与开发人员的外语水平很高或在同一个水平上。因此整理术语词典，供大家查询与