软件工程文档模板(完整规范版)模板.doc

软件工程文档模板(完整规范版) 1总体功能要求 1软件开发平台要求 1软件项目的开发实施过程管理要求 2软件项目实施过程总体要求 2软件项目实施变更要求 2软件项目实施里程碑控制 3软件的需求分析 3需求分析 3需求分析报告的编制者 4需求报告评审 4需求报告格式 4软件的概要设计 4概要设计 4编写概要设计的要求 4概要设计报告的编写者 4概要设计和需求分析、详细设计之间的关系和区别 4概要设计的评审 4概要设计格式 4软件的详细设计 5详细设计 5特例 5详细设计的要求 5数据库设计 5详细设计的评审 5详细设计格式 5软件的编码 5软件编码 5软件编码的要求 5编码的评审 6编程规范及要求 6软件的测试 6软件测试 6测试计划 6软件的交付准备 6交付清单 6软件的鉴定验收 7软件的鉴定验收 7验收人员 7验收具体内容 7软件验收测试大纲 7培训 7系统应用培训 7系统管理的培训(可选) 8附录A软件需求分析报告文档模板 9附录B软件概要设计报告文档模板 21附录C软件详细设计报告文档模板 33附录D软件数据库设计报告文档模板 43附录E软件测试(验收)大纲 55范围本指南用于指导软件开发者为南京市交通局开发软件项目的过程,通过规范软件项目承担单位的开发过程达到提高软件质量,降低维护成本的目的。开发者应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。在本指南的附录A至E中提供了文档的编写模板供开发者参考,在进行具体软件开发时,开发者可根据实际情况采编写,但必须提供双方约定的文档,文档中约定的内容必须描述清楚。/技术为核心。开发者应在充分分析需求的基础上,选择采用B/S结构或者C/S结构。软件系统的数据库应依照《南京市交通局信息化数据库建设规范》进行设计和建设。本指南中没有规定开发者采用何种具体的软件工程开发方法,开发者可根据项目具体特点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数据的方法,但建议开发商使用面向对象软件工程的方法,如:采用当前被广泛使用的RUP(RationalUnifiedProcess)方法来进行分析、设计和开发。软件开发平台要求开发者开发的软件必须能够在南京市交通局规定的软件平台上正常运行。当前软件平台为:数据库管理系统:Oracle9i以上版本中间件(应用服务器)系统:IBMWebSphereOA系统:LotusDomino/Notes网络架构:完全支持TCP/IP协议开发工具或技术体系:为保证软件的上下兼容性,开发者应选择比较通用的开发工具的较新版本进行开发,如MicrosoftVisual,BorlandDelphi,C++Builder,或J2EE(Java2P1atformEnterpriseEdition)等。软件项目的开发实施过程管理要求软件项目实施过程总体要求开发者提交软件开发工作大纲,交通局组织专家组对工作大纲进行评审,并提出整改意见。通过评审后,开发者根据整改意见完善工作大纲,经过交通局认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行,在开发过程中,开发者需分阶段提交相关文档。在软件开发工作完成后,开发者应向交通局提交完整的软件文档,交通局组织验收组对软件进行验收审查。软件项目实施变更要求在开发过程中,需求或设计不可避免地需要发生变更,相关变更必须经过交通局书面同意方可进行。在需求或设计发生变更时,需要对原有文档进行修改,并提供完整的变更记录,以使变更处于可控制的状态。变更单如下表所示:表2-1变更单需求变更申请申请变更的需求文档输入名称,版本,日期等信息变更的内客及其理由评估需求变更将对项目造成的影响申请人签字变更申请的审批意见项目经理签字审批意见:签字日期客户签字(合同项目)审批意见:签字日期更改需求文档变更后的需求文档输入名称,版本,完成日期等信息更改人签字重新评审需求文档需求评审小组签字评审意见:签字日期变更结束项目经理签字签字日期软件项目实施里程碑控制交通局将分四个阶段进行把关,召开专家审查会。需求分析(结合原型进行审查)确认;概要设计+数据库设计;预验收(试运行后);正式验收(推广使用后)。软件开发合同签订以后,项目承担单位即可组织项目组进行软件开发工作。软件开发必须严格按照软件工程的要求进行。开发过程包括开发者的活动和任务。此过程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。软件的需求分析需求分析首先,开发者和交通局应共同对交通局的应用需求作充分的调研,提交完整的需求分析报告。在需求分析报告中必须描述的基本问题是:功能、性能、强加于实现的设计限制、属性、外部接口。应当避免把设计或项目需求写