软件项目开发各阶段文档模板58773.docx
《软件项目开发各阶段文档模板58773.docx》由会员分享,可在线阅读,更多相关《软件项目开发各阶段文档模板58773.docx(124页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、目录 1. 范围12. 总体体要求12.1 总总体功能能要求12.2 软软件开发发平台要要求12.3 软软件项目目的开发发实施过过程管理理要求22.3.11 软件件项目实实施过程程总体要要求22.3.22 软件件项目实实施变更更要求22.3.33 软件件项目实实施里程程碑控制制23. 软件件开发33.1 软软件的需需求分析析33.1.11 需求求分析33.1.22 需求求分析报报告的编编制者43.1.33 需求求报告评评审43.1.44 需求求报告格格式43.2 软软件的概概要设计计43.2.11 概要要设计43.2.22 编写写概要设设计的要要求43.2.33 概要要设计报报告的编编写者43
2、.2.44 概要要设计和和需求分分析、详详细设计计之间的的关系和和区别43.2.55 概要要设计的的评审43.2.66 概要要设计格格式43.3 软软件的详详细设计计53.3.11 详细细设计53.3.22 特例例53.3.33 详细细设计的的要求53.3.44 数据据库设计计53.3.55 详细细设计的的评审53.3.66 详细细设计格格式53.4 软软件的编编码53.4.11 软件件编码53.4.22 软件件编码的的要求53.4.33 编码码的评审审63.4.44 编程程规范及及要求63.5 软软件的测测试63.5.11 软件件测试63.5.22 测试试计划63.6 软软件的交交付准备备6
3、3.6.11 交付付清单63.7 软软件的鉴鉴定验收收73.7.11 软件件的鉴定定验收73.7.22 验收收人员73.7.33 验收收具体内内容73.7.44 软件件验收测测试大纲纲73.8 培培训73.8.11 系统统应用培培训73.8.22 系统统管理的的培训(可可选)8附录A 软件需需求分析析报告91. 引言言111.1 编编写目的的111.2 项项目风险险111.3 文文档约定定111.4 预预期读者者和阅读读建议111.5 产产品范围围121.6 参参考文献献122. 综合合描述122.1 产产品的状状况122.2 产产品的功功能132.3 用用户类和和特性132.4 运运行环境境
4、132.5 设设计和实实现上的的限制132.6 假假设和约约束(依依赖)143. 外部部接口需需求143.1 用用户界面面143.2 硬硬件接口口153.3 软软件接口口153.4 通通讯接口口164. 系统统功能需需求164.1 说说明和优优先级164.2 激激励响响应序列列174.3 输输入输输出数据据175. 其它它非功能能需求175.1 性性能需求求175.2 安安全措施施需求185.3 安安全性需需求185.4 软软件质量量属性185.5 业业务规则则185.6 用用户文档档186. 词汇汇表197. 数据据定义198. 分析析模型209. 待定定问题列列表20附录B 软软件概要要设
5、计报报告211. 引言言231.1 编编写目的的231.2 项项目风险险231.3 预预期读者者和阅读读建议231.4 参参考资料料232. 设计计概述242.1 限限制和约约束242.2 设设计原则则和设计计要求243. 系统统逻辑设设计253.1 系系统组织织设计253.2 系系统结构构设计253.2.11 系统统特性表表263.2.22 系统统特性结结构图273.3 系系统接口口设计273.3.11 系统统接口表表273.3.22 系统统接口传传输协议议说明283.4 系系统完整整性设计计284. 系统统出错处处理设计计294.1 系系统出错错处理表表294.2 维维护处理理过程表表30
6、5. 技术术设计315.1 系系统开发发技术说说明表315.2 开开发技术术应用说说明326. 数据据库设计计327. 词汇汇表328. 进度度计划32附录C 软件件详细设设计报告告331. 引言言351.1 编编写目的的351.2 项项目风险险351.3 文文档约定定351.4 预预期读者者和阅读读建议351.5 参参考资料料362. 支撑撑环境362.1 数数据库管管理系统统362.2 开开发工具具、中间间件以及及数据库库接口372.3 硬硬件环境境372.4 网网络环境境382.5 多多种支撑撑环境开开发要点点383. 部件件详细设设计384. 词汇汇表395. 部件件表格式式406.
7、界面面表格式式40附录D 软件件数据库库设计报报告431. 引言言451.1 编编写目的的451.2 项项目来源源451.3 文文档约定定451.4 预预期读者者和阅读读建议451.5 参参考资料料452. 数据据库命名名规则463. 数据据库设计计说明463.1 数数据库逻逻辑设计计463.2 数数据库物物理设计计463.3 数数据库分分布473.4 基基表设计计473.5 视视图设计计483.6 索索引设计计493.7 完完整性约约束503.8 授授权设计计503.9 触触发器设设计513.10 存储过过程设计计513.11 数据复复制设计计524. 词汇汇表535. 历史史数据处处理53
8、附录E 软件件测试(验验收)大大纲551. 引言言571.1 目目的571.2 术术语571.3 参参照标准准572. 测试试日期安安排583. 测试试小组及及成员584. 测试试具体内内容584.1 合合法性检检查584.2 软软件文档档检查584.2.11 必须须提供检检查的文文档584.2.22 其他他可能需需要检查查的文档档594.2.33 由业业主确定定必须检检查的其其他文档档594.2.44 文档档质量的的度量准准则594.3 软软件代码码测试594.3.11 源代代码一般般性检查查594.3.22 软件件一致性性检查604.4 软软件系统统测试604.4.11 界面面(外观观)测
9、试试614.4.22 可用用性测试试614.4.33 功能能测试614.4.44 稳定定性(强强度)测测试614.4.55 性能能测试614.4.66 强壮壮性(恢恢复)测测试614.4.77 逻辑辑性测试试614.4.88 破坏坏性测试试614.4.99 安全全性测试试625. 测试试结果交交付方式式621141. 范围本指南用于于指导软软件开发发者为南南京市交交通局开开发软件件项目的的过程,通通过规范范软件项项目承担担单位的的开发过过程达到到提高软软件质量量,降低低维护成成本的目目的。开开发者应应根据本本指南进进行软件件开发和和编制软软件开发发文档。本本指南是是对软件件项目承承担单位位的基
10、本本要求。2. 总体要求2.1 总体功能要要求网络应用环环境以IInteerneet/IIntrraneet技术术为核心心。开发者应在在充分分分析需求求的基础础上,选选择采用用B/SS结构或或者C/S结构构。软件系统的的数据库库应依照照南京京市交通通局信息息化数据据库建设设规范进进行设计计和建设设。本指南中没没有规定定开发者者采用何何种具体体的软件件工程开开发方法法,开发发者可根根据项目目具体特特点、自自身擅长长来选择择采用面面向过程程的方法法、面向向对象的的方法或或面向数数据的方方法,但但建议开开发 商商使用面面向对象象软件工工程的方方法,如如:采用用目前被被广泛使使用的RRUP(Ratti
11、onnal Uniifieed PProccesss)方法法来进行行分析、设设计和开开发。2.2 软件开发平平台要求求数据库管理理系统:Oraclle 99i以上上版本开发工具系系统:Microosofft VVisuual Stuudioo 20010OS系统:Windoows 20003完全支持TTCP/IP协协议2.3 软件项目的的开发实实施过程程管理要要求2.3.1 软件项目实实施过程程总体要要求(一) 开发者提交交软件开开发工作作大纲,交通局组织专家组对工作大纲进行评审,并提出整改意见。(二) 通过评审后后,开发发者根据据整改意意见完善善工作大大纲,经经过交通通局认可可后组织织项目组
12、组进行软软件开发发。软件件开发工工作按照照需求分分析、概概要设计计、详细细设计、编编码、测测试等几几个阶段段进行,在在开发过过程中,开开发者需需分阶段段提交相相关文档档。(三) 在软件开发发工作完完成后,开开发者应应向交通通局提交交完整的的软件文文档,交交通局组组织验收收组对软软件进行行验收审审查。2.3.2 软件项目实实施变更更要求在开发过程程中,需需求或设设计不可可避免地地需要发发生变更更,相关关变更必必须经过过交通局局书面同同 意意方可进进行。在在需求或或设计发发生变更更时,需需要对原原有文档档进行修修改,并并提供完完整的变变更记录录, 以使变变更处于于可控制制的状态态。变更更单如下下表
13、所示示:表 2-11 变更更单需求变更申申请申请变更的的需求文文档 输入名名称,版版本,日日期等信信息变更的内客客及其理理由 评估需求变变更将对对项目造成的的影响 申请人签字字 变更申请的的审批意意见项目经理签签字 审批意意见: 签字字 日期 客户签字(合同项目目) 审批意意见: 签字字 日期 更改需求文文档变更后的需求文档 输入名名称,版版本,完完成日期期等信息息 更改人签字字 重新评审需需求文档档需求评审小小组签字字 评审意意见: 签字字 日期 变更结束项目经理签签字 签字字 日期 2.3.3 软件项目实实施里程程碑控制制交通局将分分四个阶阶段进行行把关,召召开专家家审查会会。(一) 需求
14、分析析(结合合原型进进行审查查)确认认;(二) 概要设计计+数据据库设计计;(三) 预验收(试试运行后后);(四) 正式验收收(推广广使用后后)。3. 软件开发合同签订以以后,项项目承担担单位即即可组织织项目组组进行软软件开发发工作。软软件开发发必须严严格按照照软件工工程的要要求进行行。开发发过程包包括开发发者的活活动和任任务。此此过程由由软件需需求分析析、概要要设计、详详细设计计、编码码、测试试、验收收、鉴定定等活动动组成。3.1 软件的需求求分析3.1.1 需求分析首先,开发发者和交交通局应应共同对对交通局局的应用用需求作作充分的的调研,提提交完整整的需求求分析 报告告。在需需求分析析报告
15、中中必须描描述的基基本问题题是:功功能、性性能、强强加于实实现的设设计限制制、属 性、外外部接口口。应当当避免把把设计或或项目需需求写入入需求分分析报告告中。它它必须说说明由软软件获得得的 结果,而而不是获获得这些些结果的的手段。软件需求可可以用若若干种方方法来表表达,如如通过输输入、输输出说明明;使用用代表性性的例子子;用规规范化的的模型。开发者应尽可能地使用模型的方式,因为这是表达复杂需求的精确和有效的方法。比如用统一建模语言(UML)来描述需求。编写需求分分析报告告的要求求a无歧义义性对最终产品品的每一一个特性性用某一一术语描描述;若若某一术术语在某某一特殊殊的行文文中使用用时具有有多种
16、含含义,那那么应对对该术语语的每种种含义做做出解释释并指出出其适用用场合。b完整性性需求分析报报告应该该包括全全部有意意义的需需求,无无论是关关系到功功能的、性性能的、设设计约束束的、还还是关系系到外部部接口方方面的需需求;对对所有可可能出现现的输入入数据的的响应予予以定义义,要对对合法和和非合法法的输入入值的响响应做出出规定;填写全全部插图图、表、图图示标记记等;定定义全部部术语和和度量单单位。c可验证证性需求分析报报告描述述的每一一个需求求应是可可以验证证的。可可以通过过一个有有限处理理过程来来检查软软件产品品是否满满足需求求。d一致性性在需求分析析报告中中的各个个需求的的描述不不能互相相
17、矛盾。e可修改改性需求分析报报告应具具有一个个有条不不紊、易易于使用用的内容容组织;没有冗冗余,即即同一需需求不能能在需求求分析报报告中出出现多次次。f可追踪踪性每一个需求求的源流流必须清清晰,在在进一步步产生和和改变文文件编制制时,可可以方便便地引证证每一个个需求。g运行和和维护阶阶段的可可使用性性需求分析报报告必须须满足运运行和维维护阶段段的需要要。在需需求分析析报告要要写明功功能的来来源和目目的。3.1.2 需求分析报报告的编编制者需求分析报报告应由由交通局局和开发发者双方方共同完完成。其其中:交交通局负负责根据据实际需需要提出出希望软软件实现现的功能能;软件件开发者者根据交交通局提提出
18、的性性能需求求,结合合软件开开发编写写需求分分析。3.1.3 需求报告评评审在软件需求求分析工工作完成成后,软软件开发发者应向向交通局局提交软软件需求求分析报报告。交交通局组组织有关关人员对对需求进进行评审审,以决决定软件件需求是是否完善善和恰当当。评审审完成后后,就可可以进入入软件的的设计阶阶段。3.1.4 需求报告格格式软件需求求分析报报告需需按一定定的格式式进行编编写,具具体的软软件需求求分析报报告文文档编写写模板请请见附录录A。3.2 软件的概要要设计3.2.1 概要设计在交通局和和开发者者双方认认可的需需求分析析报告基基础上,开开发者进进行下步的的工作。 首先,开开发者需需要对软软件
19、系统统进行概概要设计计,即系系统设计计。概要要设计需需要对软软件系统统的设计计 进行行考虑,包包括系统统的基本本处理流流程、系系统的组组织结构构、模块块划分、功功能分配配、接口口设计、 运行设设计、数数据结构构设计和和出错处处理设计计等,为为软件的的详细设设计提供供基础。3.2.2 编写概要设设计的要要求a一致性性概要设计的的要求应应该与需需求分析析报告所所描述的的需求一一致。同同时,概概要设计计的各项项要求之之间也应应该一致致。b合理性性概要设计所所提出的的设计方方法和标标准应该该是合理理的、恰恰当的。c可追踪踪性对概要设计计所提出出的各项项要求应应该可以以得到它它的清晰晰的源流流,即在在需
20、求分分析报告告客户有有明确的的需求描描述。d可行性性根据概要设设计进行行详细设设计、操操作和维维护应该该是可行行的。3.2.3 概要设计报报告的编编写者概要设计报报告由开开发者根根据需求求分析报报告的要要求进行行编写。3.2.4 概要设计和和需求分分析、详详细设计计之间的的关系和和区别 需求分析析不涉及及具体的的技术实实现,而而概要设设计注重重于从宏宏观上和和框架上上来描述述采用何何种技术术手段、方方法来实实现这些些需求。详详细设计计相对概概要设计计更注重重于微观观上和框框架内的的设计, 是编码码的依据据。概要要设计是是指导详详细设计计的依据据。3.2.5 概要设计的的评审在软件概要要设计工工
21、作完成成后,软软件开发发者应向向交通提提交软软件系统统概要设设计报告告。在在交通局局对概概要设计计报告评评审通过过后,即即可进入入详细设设计阶段段。3.2.6 概要设计格格式软件系统统概要设设计报告告需按按一定的的格式进进行编写写,具体体的软软件系统统概要设设计报 告文文档编写写模板请请见附录录B。3.3 软件的详细细设计3.3.1 详细设计在概要设计计的基础础上,开开发者需需要进行行软件系系统的详详细设计计。在详详细设计计中,描描述实 现具体体模块所所涉及到到的主要要算法、数数据结构构、类的的层次结结构及调调用关系系,需要要说明软软件系统统各个层层次中的的每一个个程序(每个模模块或子子程序)
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 项目 开发 阶段 文档 模板 58773
限制150内