软件项目开发各阶段文档模板

《软件项目开发各阶段文档模板》由会员分享，可在线阅读，更多相关《软件项目开发各阶段文档模板（67页珍藏版）》请在金锄头文库上搜索。

1、目录目录 1. 范围范围.1 2. 总体要求总体要求.1 2.1 总体功能要求1 2.2 软件开发平台要求1 2.3 软件项目的开发实施过程管理要求2 2.3.1 软件项目实施过程总体要求.2 2.3.2 软件项目实施变更要求.2 2.3.3 软件项目实施里程碑控制.2 3. 软件开发软件开发.3 3.1 软件的需求分析3 3.1.1 需求分析.3 3.1.2 需求分析报告的编制者.4 3.1.3 需求报告评审.4 3.1.4 需求报告格式.4 3.2 软件的概要设计4 3.2.1 概要设计.4 3.2.2 编写概要设计的要求.4 3.2.3 概要设计报告的编写者.4 3.2.4 概要设计和需

2、求分析、详细设计之间的关系和区别.4 3.2.5 概要设计的评审.4 3.2.6 概要设计格式.4 3.3 软件的详细设计5 3.3.1 详细设计.5 3.3.2 特例.5 3.3.3 详细设计的要求.5 3.3.4 数据库设计.5 3.3.5 详细设计的评审.5 3.3.6 详细设计格式.5 3.4 软件的编码5 3.4.1 软件编码.5 3.4.2 软件编码的要求.5 3.4.3 编码的评审.6 3.4.4 编程规范及要求.6 3.5 软件的测试6 3.5.1 软件测试.6 3.5.2 测试计划.6 3.6 软件的交付准备6 3.6.1 交付清单.6 3.7 软件的鉴定验收7 I 3.7.

3、1 软件的鉴定验收.7 3.7.2 验收人员.7 3.7.3 验收具体内容.7 3.7.4 软件验收测试大纲.7 3.8 培训7 3.8.1 系统应用培训.7 3.8.2 系统管理的培训（可选）.8 附录附录 A 软件需求分析报告软件需求分析报告9 1. 引言引言.11 1.1 编写目的11 1.2 项目风险11 1.3 文档约定11 1.4 预期读者和阅读建议11 1.5 产品范围12 1.6 参考文献12 2. 综合描述综合描述.12 2.1 产品的状况12 2.2 产品的功能13 2.3 用户类和特性13 2.4 运行环境13 2.5 设计和实现上的限制13 2.6 假设和约束(依赖).

4、14 3. 外部接口需求外部接口需求.14 3.1 用户界面14 3.2 硬件接口15 3.3 软件接口15 3.4 通讯接口16 4. 系统功能需求系统功能需求.16 4.1 说明和优先级16 4.2 激励响应序列17 4.3 输入输出数据17 5. 其它非功能需求其它非功能需求.17 5.1 性能需求17 5.2 安全措施需求18 5.3 安全性需求18 5.4 软件质量属性18 5.5 业务规则18 5.6 用户文档18 6. 词汇表词汇表.19 II 7. 数据定义数据定义.19 8. 分析模型分析模型.20 9. 待定问题列表待定问题列表.20 附录附录 B 软件概要设计报告软件概要

5、设计报告21 1. 引言引言.23 1.1 编写目的23 1.2 项目风险23 1.3 预期读者和阅读建议23 1.4 参考资料23 2. 设计概述设计概述.24 2.1 限制和约束24 2.2 设计原则和设计要求24 3. 系统逻辑设计系统逻辑设计.25 3.1 系统组织设计25 3.2 系统结构设计25 3.2.1 系统特性表.26 3.2.2 系统特性结构图.27 3.3 系统接口设计27 3.3.1 系统接口表.27 3.3.2 系统接口传输协议说明.28 3.4 系统完整性设计28 4. 系统出错处理设计系统出错处理设计.29 4.1 系统出错处理表29 4.2 维护处理过程表30

6、5. 技术设计技术设计.31 5.1 系统开发技术说明表31 5.2 开发技术应用说明32 6. 数据库设计数据库设计.32 7. 词汇表词汇表.32 8. 进度计划进度计划.32 附录附录 C 软件详细设计报告软件详细设计报告33 1. 引言引言.35 1.1 编写目的35 1.2 项目风险35 1.3 文档约定35 1.4 预期读者和阅读建议35 1.5 参考资料36 III 2. 支撑环境支撑环境.36 2.1 数据库管理系统36 2.2 开发工具、中间件以及数据库接口37 2.3 硬件环境37 2.4 网络环境38 2.5 多种支撑环境开发要点38 3. 部件详细设计部件详细设计.38

7、 4. 词汇表词汇表.39 5. 部件表格式部件表格式.40 6. 界面表格式界面表格式.40 附录附录 D 软件数据库设计报告软件数据库设计报告43 1. 引言引言.45 1.1 编写目的45 1.2 项目来源45 1.3 文档约定45 1.4 预期读者和阅读建议45 1.5 参考资料45 2. 数据库命名规则数据库命名规则.46 3. 数据库设计说明数据库设计说明.46 3.1 数据库逻辑设计46 3.2 数据库物理设计46 3.3 数据库分布47 3.4 基表设计47 3.5 视图设计48 3.6 索引设计49 3.7 完整性约束50 3.8 授权设计50 3.9 触发器设计51 3.1

8、0 存储过程设计51 3.11 数据复制设计52 4. 词汇表词汇表.53 5. 历史数据处理历史数据处理.53 附录附录 E 软件测试（验收）大纲软件测试（验收）大纲55 1. 引言引言.57 1.1 目的57 1.2 术语57 1.3 参照标准57 2. 测试日期安排测试日期安排.58 IV 3. 测试小组及成员测试小组及成员.58 4. 测试具体内容测试具体内容.58 4.1 合法性检查58 4.2 软件文档检查58 4.2.1 必须提供检查的文档.58 4.2.2 其他可能需要检查的文档.59 4.2.3 由业主确定必须检查的其他文档.59 4.2.4 文档质量的度量准则.59 4.3

9、 软件代码测试59 4.3.1 源代码一般性检查.59 4.3.2 软件一致性检查.60 4.4 软件系统测试60 4.4.1 界面(外观)测试.61 4.4.2 可用性测试.61 4.4.3 功能测试.61 4.4.4 稳定性(强度)测试.61 4.4.5 性能测试.61 4.4.6 强壮性(恢复)测试.61 4.4.7 逻辑性测试.61 4.4.8 破坏性测试.61 4.4.9 安全性测试.62 5. 测试结果交付方式测试结果交付方式.62 0 1. 范围范围 本指南用于指导软件开发者为南京市交通局开发软件项目的过程，通过规范软件项目 承担单位的开发过程达到提高软件质量，降低维护成本的目的

10、。开发者应根据本指南进行 软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。 2. 总体要求总体要求 2.1 总体功能要求总体功能要求 网络应用环境以 Internet/Intranet 技术为核心。 开发者应在充分分析需求的基础上，选择采用 B/S 结构或者 C/S 结构。 软件系统的数据库应依照南京市交通局信息化数据库建设规范进行设计和建设。 本指南中没有规定开发者采用何种具体的软件工程开发方法，开发者可根据项目具体 特点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数据的方法，但建议 开发 商使用面向对象软件工程的方法，如：采用目前被广泛使用的 RUP(Rati

11、onal Unified Process)方法来进行分析、设计和开发。 2.2 软件开发平台要求软件开发平台要求 数据库管理系统： Oracle 9i 以上版本 开发工具系统： Microsoft Visual Studio 2010 OS 系统： Windows 2003 完全支持 TCP/IP 协议 2.3 软件项目的开发实施过程管理要求软件项目的开发实施过程管理要求 2.3.1 软件项目实施过程总体要求 （一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行评审，并 提出整改意见。 （二）通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项 目组进行软件开发。软件

12、开发工作按照需求分析、概要设计、详细设计、编码、测试 等几个阶段进行，在开发过程中，开发者需分阶段提交相关文档。 （三）在软件开发工作完成后，开发者应向交通局提交完整的软件文档，交通局组 1 织验收组对软件进行验收审查。 2.3.2 软件项目实施变更要求 在开发过程中，需求或设计不可避免地需要发生变更，相关变更必须经过交通局书面 同 意方可进行。在需求或设计发生变更时，需要对原有文档进行修改，并提供完整的变 更记录， 以使变更处于可控制的状态。变更单如下表所示： 表 2-1 变更单 需求变更申请 申请变更的需求文档 输入名称，版本，日期等信息 变更的内客及其理由 评估需求变更将对 项目造成的影

13、响 申请人签字 变更申请的审批意见 项目经理签字 审批意见： 签字 日期 客户签字 (合同项目) 审批意见： 签字 日期 更改需求文档 变更后的 需求文档 输入名称，版本，完成日期等信息 更改人签字 重新评审需求文档 需求评审小组签字 评审意见： 签字 日期 变更结束 项目经理签字 签字 日期 2.3.3 软件项目实施里程碑控制 交通局将分四个阶段进行把关，召开专家审查会。 （一） 需求分析（结合原型进行审查）确认； （二） 概要设计+数据库设计； （三） 预验收（试运行后） ； （四） 正式验收（推广使用后） 。 3. 软件开发软件开发 合同签订以后，项目承担单位即可组织项目组进行软件开发工

14、作。软件开发必须严格 按照软件工程的要求进行。开发过程包括开发者的活动和任务。此过程由软件需求分析、 概要设计、详细设计、编码、测试、验收、鉴定等活动组成。 2 3.1 软件的需求分析软件的需求分析 3.1.1 需求分析 首先，开发者和交通局应共同对交通局的应用需求作充分的调研，提交完整的需求分 析 报告。在需求分析报告中必须描述的基本问题是：功能、性能、强加于实现的设计限 制、属 性、外部接口。应当避免把设计或项目需求写入需求分析报告中。它必须说明由软 件获得的 结果，而不是获得这些结果的手段。 软件需求可以用若干种方法来表达，如通过输入、输出说明；使用代表性的例子；用 规范化的模型。开发者

15、应尽可能地使用模型的方式，因为这是表达复杂需求的精确和有效 的方法。比如用统一建模语言（UML）来描述需求。 编写需求分析报告的要求 a无歧义性 对最终产品的每一个特性用某一术语描述；若某一术语在某一特殊的行文中使用时具 有多种含义，那么应对该术语的每种含义做出解释并指出其适用场合。 b完整性 需求分析报告应该包括全部有意义的需求，无论是关系到功能的、性能的、设计约束 的、还是关系到外部接口方面的需求；对所有可能出现的输入数据的响应予以定义，要对 合法和非合法的输入值的响应做出规定；填写全部插图、表、图示标记等；定义全部术语 和度量单位。 c可验证性 需求分析报告描述的每一个需求应是可以验证的

16、。可以通过一个有限处理过程来检查 软件产品是否满足需求。 d一致性 在需求分析报告中的各个需求的描述不能互相矛盾。 e可修改性 需求分析报告应具有一个有条不紊、易于使用的内容组织；没有冗余，即同一需求不 能在需求分析报告中出现多次。 f可追踪性 每一个需求的源流必须清晰，在进一步产生和改变文件编制时，可以方便地引证每一 个需求。 g运行和维护阶段的可使用性 需求分析报告必须满足运行和维护阶段的需要。在需求分析报告要写明功能的来源和 目的。 3.1.2 需求分析报告的编制者 需求分析报告应由交通局和开发者双方共同完成。其中：交通局负责根据实际需要提 出希望软件实现的功能；软件开发者根据交通局提出的性能需求，结合软件开发编写需求 分析。 3.1.3 需求报告评审 在软件需求分析工作完成后，软件