20170308 的软件开发中的文档要求.docx

软件开发中的文档要求刘宏2017年3月8日近日，接受了一个任务，检查某软件研发项目的文档是否完整与齐全。检查文档是否齐全，首先遇到的问题是：根据什么说文档是齐全的？或者说评价文档齐全的标准是什么？为此重新学习ISO12207标准。在ISO11207标准中给出基本的要求，在此基础上与业务部门进行沟通，确定了某软件研发项目所需要的文档。以下内容是ISO12207标准中与软件开发相关的过程要求，这些可为需要了解软件需求开发、软件设计的同事提供参考。在每个开发活动中都明确文档的要求，并对文档明确评价的准则。在ISO12207标准中开发过程包括开发方的活动和任务。该过程包括需求分析、设计、编码、集成、测试、和与软件产品有关的安装和验收等活动。本过程包括下述活动：系统需求分析；系统体系结构设计；软件需求分析；软件体系结构设计；软件详细设计；软件编码和测试；软件集成；软件和性测试；系统集成；系统合格性测试；软件安装；软件验收支持。系统需求分析此项活动由下列任务组成，开发方应按照合同要求执行或支持这些任务。应分析带开发系统的特定的预期使用要求，宜规定系统需求。系统需求规格说明应描述：系统的功能与能力；业务、组织和用户的需求；安全、安全保密性、人因工程（人机工程学）、接口、运行和维护需求；设计约束和合格性需求；系统需求规格说明应形成文档。应根据下列评价准则评价系统需求。评价结果应形成文档：获取需要的可追踪性；获取需要的一致性；可测试性；系统体系结构设计的可行性；运行和维护的可行性。系统体系结构设计此项活动由下列任务组成，开发方应按照合同要求执行或支持这些任务。应建立系统的顶层体系结构。该体系结构应标识硬件、软件和人工操作项。应确保所有系统需求被分配到各项中，然后应从这些项中表示出硬件配置项、软件配置项和手工操作项。分配到各项中的系统体系及结构和系统需求应形成文档。应根据下列评价准则评价项的系统体系结构和需求。评价结果应形成文档。系统需求的可追踪性；与系统需求的一致性；所使用的设计标准和方法的适宜性；软件项满足其分配需求的可行性；运行与维护的可行性。软件需求分析对于每一个软件项（或软件配置项，如果已标识），此项活动由下述任务组成：开发方应建立软件需求（包括质量特性规格说明）并形成文档。软件质量特性规定见GB/T 16260.1。软件需求包括：功能与能力规格说明，包括性能、物理特性和软件项执行的环境条件；软件的外部接口；合格性需求；安全规格说明，包括那些与运行、维护相关的方法、环境影响和人为损坏；安全保密性规格说明。包括那些与敏感信息泄漏相关的要求；人因工程（人际工程学）规格说明，包括与人工操作、人机界面、对人员的约束、需要人员集中注意力的区域（这些区域对人为差错和培训是敏感的）等有关的要求；数据定义和数据库需求；在运行和维护场所安装与验收已交付的软件产品的需求；用户文档；用户操作与执行需求；用户维护需求。开发方应根据下列评价准则评价软件需求。评价结果应形成文档：系统需求和系统设计的可追踪性；与系统需求的外部一致性；内部一致性；可测试性；软件设计可行性；运行和维护的可行性。开发方应实施正式评审。软件体系结构设计对于每一个软件项（或软件配置项，如果已标识），此项活动由下列任务组成：开发方应把软件项的需求转变为一种体系结构，该体系结构描述其顶层结果并表示各个软件部件。应确定软件项的所有需求被分配给了其软件部件，并得到进一步的细化以便于进行详细设计。软件项的体系结构应形成文档。开发方应开发关于软件项的外部接口以及软件项的各个软件部件间的接口的顶层设计，并形成文档。开发方应编制数据库的顶层设计，并形成文档。开发方宜编制用户文档的最初版本，并形成文档。开发方应确定软件集成的最初测试需求和进度安排，并形成文档。开发方应根据下列评价准则评价软件项的体系结构、接口和数据库设计，评价结果应形成文档：软件项需求的追踪性；与软件项需求的外部一致性；软件部件之间的内部一致性；所应用的设计方法和标准的适宜性；详细设计的可行性；运行与维护的可行性。开发方应实施正式评审。软件详细设计对于每一个软件项（或软件配置项，如果已标识），此项活动由下述任务组成：开发方应对软件项的每一软件部件进行详细设计。软件部件应细化到更低级别，这些级别包含能被编码、编译、测试的软件单元。应确保来自这些软件部件的所有软件项需求都被分配到软件单元。详细设计应形成文档。开发方应开发关于软件项外部接口，软件部件之间以及软件单元之间的接口的详细设计，并将其形成文档。接口的详细设计应允许在不需要更多信息的情况下进行编码。开发方应编制数据的详细设计并形成文档。必要时，开发方应更新用户文档。开发方应规定要测试的软件单元的测试需求和进度安排，并将其形成文档。测试需求宜包括对软件的单元在需求边界的强化要求。开发方应更新软