《软件开发模板》由会员分享，可在线阅读，更多相关《软件开发模板（16页珍藏版）》请在金锄头文库上搜索。
1、-软件开发文档模板附录A软件需求分析报告文档模板附录B软件概要设计报告文档模板附录C软件详细设计报告文档模板附录D软件数据库设计报告文档模板附录E软件测试(验收)大纲目录1.围42.总体要求42.1总体功能要求42.2软件开发平台要求42.3软件工程的开发实施过程管理要求52.3.1软件工程实施过程总体要求52.3.2软件工程实施变更要求52.3.3软件工程实施里程碑控制63.软件开发63.1软件的需求分析63.1.1需求分析63.1.2需求分析报告的编制者73.1.3需求报告评审73.1.4需求报告格式73.2软件的概要设计73.2.1概要设计73.2.2编写概要设计的要求73.2.3概要设
2、计报告的编写者83.2.4概要设计和需求分析、详细设计之间的关系和区别83.2.5概要设计的评审83.2.6概要设计格式83.3软件的详细设计83.3.1详细设计83.3.2特例83.3.3详细设计的要求83.3.4数据库设计93.3.5详细设计的评审93.3.6详细设计格式93.4软件的编码93.4.1软件编码93.4.2软件编码的要求93.4.3编码的评审93.4.4编程规及要求93.5软件的测试93.5.1软件测试93.5.2测试方案103.6软件的交付准备103.6.1交付清单103.7软件的鉴定验收103.7.1软件的鉴定验收103.7.2验收人员103.7.3验收具体容113.7.
3、4软件验收测试大纲113.8培训113.8.1系统应用培训113.8.2系统管理的培训可选111.围本指南用于指导软件开发者为市交通局开发软件工程的过程，通过规软件工程承担单位的开发过程到达提高软件质量，降低维护本钱的目的。开发者应根据本指南进展软件开发和编制软件开发文档。本指南是对软件工程承担单位的根本要求。在本指南的附录A至E中提供了文档的编写模板供开发者参考，在进展具体软件开发时，开发者可根据实际情况采编写，但必须提供双约定的文档，文档中约定的容必须描述清楚。2.总体要求2.1总体功能要求网络应用环境以Internet/Intranet技术为核心。开发者应在充分分析需求的根底上，选择采用
4、B/S构造或者C/S构造。软件系统的数据库应依照?市交通局信息化数据库建立规?进展设计和建立。本指南中没有规定开发者采用种具体的软件工程开发法，开发者可根据工程具体特点、自身擅长来选择采用面向过程的法、面向对象的法或面向数据的法，但建议开发商使用面向对象软件工程的法，如：采用目前被广泛使用的RUP(Rational Unified Process)法来进展分析、设计和开发。2.2软件开发平台要求开发者开发的软件必须能够在市交通局规定的软件平台上正常运行。目前软件平台为：数据库管理系统：Oracle 9i以上版本中间件(应用效劳器)系统：IBM WebSphereOA系统：Lotus Domin
5、o/Notes网络架构：完全支持TCP/IP协议开发工具或技术体系：为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进展开发，如Microsoft Visual Studio.Net，Borland Delphi，C+ Builder,或J2EE(Java2 P1atform Enterprise Edition)等。2.3软件工程的开发实施过程管理要求软件工程实施过程总体要求一开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进展评审，并提出整改意见。二通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织工程组进展软件开发。软件开发工作按照需求分析、概要设计、
6、详细设计、编码、测试等几个阶段进展，在开发过程中，开发者需分阶段提交相关文档。三在软件开发工作完成后，开发者应向交通局提交完整的软件文档，交通局组织验收组对软件进展验收审查。软件工程实施变更要求在开发过程中，需求或设计不可防止地需要发生变更，相关变更必须经过交通局书面同意可进展。在需求或设计发生变更时，需要对原有文档进展修改，并提供完整的变更记录，以使变更处于可控制的状态。变更单如下表所示：表2-1变更单需求变更申请申请变更的需求文档输入名称，版本，日期等信息变更的客及其理由评估需求变更将对工程造成的影响申请人签字变更申请的审批意见工程经理签字审批意见：签字日期客户签字(合同工程)审批意见：签
7、字日期更改需求文档变更后的需求文档输入名称，版本，完成日期等信息更改人签字重新评审需求文档需求评审小组签字评审意见：签字日期变更完毕工程经理签字签字日期软件工程实施里程碑控制交通局将分四个阶段进展把关，召开专家审查会。一需求分析结合原型进展审查确认；二概要设计+数据库设计；三预验收试运行后；四正式验收推广使用后。3.软件开发合同签订以后，工程承担单位即可组织工程组进展软件开发工作。软件开发必须格按照软件工程的要求进展。开发过程包括开发者的活动和任务。此过程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。3.1软件的需求分析需求分析首先，开发者和交通局应共同对交通局的应用需
8、求作充分的调研，提交完整的需求分析报告。在需求分析报告中必须描述的根本问题是：功能、性能、强加于实现的设计限制、属性、外部接口。应当防止把设计或工程需求写入需求分析报告中。它必须说明由软件获得的结果，而不是获得这些结果的手段。软件需求可以用假设干种法来表达，如通过输入、输出说明；使用代表性的例子；用规化的模型。开发者应尽可能地使用模型的式，因为这是表达复杂需求的准确和有效的法。比方用统一建模语言UML来描述需求。编写需求分析报告的要求a无歧义性对最终产品的每一个特性用*一术语描述；假设*一术语在*一特殊的行文中使用时具有多种含义，则应对该术语的每种含义做出解释并指出其适用场合。b完整性需求分析
9、报告应该包括全部有意义的需求，无论是关系到功能的、性能的、设计约束的、还是关系到外部接口面的需求；对所有可能出现的输入数据的响应予以定义，要对合法和非合法的输入值的响应做出规定；填写全部插图、表、图示标记等；定义全部术语和度量单位。c可验证性需求分析报告描述的每一个需求应是可以验证的。可以通过一个有限处理过程来检查软件产品是否满足需求。d一致性在需求分析报告中的各个需求的描述不能互相矛盾。e可修改性需求分析报告应具有一个有条不紊、易于使用的容组织；没有冗余，即同一需求不能在需求分析报告中出现屡次。f可追踪性每一个需求的源流必须清晰，在进一步产生和改变文件编制时，可以便地引证每一个需求。g运行和
10、维护阶段的可使用性需求分析报告必须满足运行和维护阶段的需要。在需求分析报告要写明功能的来源和目的。需求分析报告的编制者需求分析报告应由交通局和开发者双共同完成。其中：交通局负责根据实际需要提出希望软件实现的功能；软件开发者根据交通局提出的性能需求，结合软件开发编写需求分析。需求报告评审在软件需求分析工作完成后，软件开发者应向交通局提交?软件需求分析报告?。交通局组织有关人员对需求进展评审，以决定软件需否完善和恰当。评审完成后，就可以进入软件的设计阶段。需求报告格式?软件需求分析报告?需按一定的格式进展编写，具体的?软件需求分析报告?文档编写模板请见附录A。3.2软件的概要设计概要设计在交通局和
11、开发者双认可的?需求分析报告?根底上，开发者进展下步的工作。首先，开发者需要对软件系统进展概要设计，即系统设计。概要设计需要对软件系统的设计进展考虑，包括系统的根本处理流程、系统的组织构造、模块划分、功能分配、接口设计、运行设计、数据构造设计和出错处理设计等，为软件的详细设计提供根底。编写概要设计的要求a一致性概要设计的要求应该与需求分析报告所描述的需求一致。同时，概要设计的各项要求之间也应该一致。b合理性概要设计所提出的设计法和标准应该是合理的、恰当的。c可追踪性对概要设计所提出的各项要求应该可以得到它的清晰的源流，即在需求分析报告客户有明确的需求描述。d可行性根据概要设计进展详细设计、操作
12、和维护应该是可行的。概要设计报告的编写者概要设计报告由开发者根据需求分析报告的要求进展编写。概要设计和需求分析、详细设计之间的关系和区别需求分析不涉及具体的技术实现，而概要设计注重于从宏观上和框架上来描述采用种技术手段、法来实现这些需求。详细设计相对概要设计更注重于微观上和框架的设计，是编码的依据。概要设计是指导详细设计的依据。概要设计的评审在软件概要设计工作完成后，软件开发者应向交通提交?软件系统概要设计报告?。在交通局对?概要设计报告?评审通过后，即可进入详细设计阶段。概要设计格式?软件系统概要设计报告?需按一定的格式进展编写，具体的?软件系统概要设计报告?文档编写模板请见附录B。3.3软
13、件的详细设计详细设计在概要设计的根底上，开发者需要进展软件系统的详细设计。在详细设计中，描述实现具体模块所涉及到的主要算法、数据构造、类的层次构造及调用关系，需要说明软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑，以便进展编码和测试。应当保证软件的需求完全分配给整个软件。详细设计应当足够详细，能够根据详细设计报告进展编码。特例如果软件系统比较简单，层次较少，可以不必进展专门的详细设计，而和概要设计结合起来。详细设计的要求a一致性详细设计的要求应该与需求分析报告所描述的需求、与概要设计一致。同时，详细设计的各项要求之间也应该是一致的。b合理性详细设计所提出的设计法和标准应该是合理的、恰当的。c可追踪性对详细设计所提出的各项要求应该可以得到它的清晰的源流，即可在需求分析报告、概要设计报告中有明确的需求描述。d可行性根据详细设计进展编码、测试、操作和维护应该是可行的。数据库设计如果软件产品
