软件开发需求分析文档.docx
《软件开发需求分析文档.docx》由会员分享，可在线阅读，更多相关《软件开发需求分析文档.docx（75页珍藏版）》请在冰点文库上搜索。
软件开发需求分析文档
9
1.范围
本指南用于指导软件开发者为南京市交通局开发软件项目的进程，通过标准软件项目承担单位的开发进程达到提高软件质量，降低保护本钱的目的。
开发者应依照本指南进行软件开发和编制软件开发文档。
本指南是对软件项目承担单位的大体要求。
在本指南的附录A至E中提供了文档的编写模板供开发者参考，在进行具体软件开发时，开发者可依如实际情形采编写，但必需提供两边约定的文档，文档中约定的内容必需描述清楚。
2.整体要求
2.1整体功能要求
网络应用环境以Internet/Intranet技术为核心。
开发者应在充分分析需求的基础上，选择采纳B/S结构或C/S结构。
软件系统的数据库应依照《南京市交通局信息化数据库建设标准》进行设计和建设。
本指南中没有规定开发者采纳何种具体的软件工程开发方式，开发者可依照项目具体特点、自身擅长来选择采纳面向进程的方式、面向对象的方式或面向数据的方式，但建议开发商利用面向对象软件工程的方式，如：
采纳目前被普遍利用的RUP（RationalUnifiedProcess）方式来进行分析、设计和开发。
2.2软件开发平台要求
开发者开发的软件必需能够在南京市交通局规定的软件平台上正常运行。
目前软件平台为：
数据库治理系统：
Oracle9i以上版本
中间件（应用效劳器）系统：
IBMWebSphere
OA系统：
LotusDomino/Notes
网络架构：
完全支持TCP/IP协议
开发工具或技术体系：
为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进行开发，如MicrosoftVisual，BorlandDelphi，C++Builder,或J2EE（Java2P1atformEnterpriseEdition）等。
2.3软件项目的开发实施进程治理要求
2.3.1软件项目实施进程总体要求
（一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行评审，并提出整改意见。
（二）通过评审后，开发者依照整改意见完善工作大纲，通过交通局认可后组织项目组进行软件开发。
软件开发工作依照需求分析、概要设计、详细设计、编码、测试等几个时期进行，在开发进程中，开发者需分时期提交相关文档。
（三）在软件开发工作完成后，开发者应向交通局提交完整的软件文档，交通局组织验收组对软件进行验收审查。
2.3.2软件项目实施变更要求
在开发进程中，需求或设计不可幸免地需要发生变更，相关变更必需通过交通局书面同意方可进行。
在需求或设计发生变更时，需要对原有文档进行修改，并提供完整的变更记录，以使变更处于可操纵的状态。
变更单如下表所示：
表2-1变更单
需求变更申请
申请变更的需求文档
输入名称，版本，日期等信息
变更的内客及其理由
评估需求变更将对
项目造成的影响
申请人签字
变更申请的审批意见
项目经理签字
审批意见：
签字日期
客户签字
（合同项目）
审批意见：
签字日期
更改需求文档
变更后的
需求文档
输入名称，版本，完成日期等信息
更改人签字
重新评审需求文档
需求评审小组签字
评审意见：
签字日期
变更结束
项目经理签字
签字日期
2.3.3软件项目实施里程碑操纵
交通局将分四个时期进行把关，召开专家审查会。
（四）需求分析（结合原型进行审查）确认；
（五）概要设计+数据库设计；
（六）预验收（试运行后）；
（七）正式验收（推行利用后）。
3.软件开发
合同签定以后，项目承担单位即可组织项目组进行软件开发工作。
软件开发必需严格依照软件工程的要求进行。
开发进程包括开发者的活动和任务。
此进程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。
3.1软件的需求分析
3.1.1需求分析
第一，开发者和交通局应一起对交通局的应用需求作充分的调研，提交完整的需求分析报告。
在需求分析报告中必需描述的大体问题是：
功能、性能、强加于实现的设计限制、属性、外部接口。
应当幸免把设计或项目需求写入需求分析报告中。
它必需说明由软件取得的结果，而不是取得这些结果的手腕。
软件需求能够用假设干种方式来表达，如通过输入、输出说明；利用代表性的例子；用标准化的模型。
开发者应尽可能地利用模型的方式，因为这是表达复杂需求的精准和有效的方式。
比如用统一建模语言（UML）来描述需求。
编写需求分析报告的要求
a．无歧义性
对最终产品的每一个特性用某一术语描述；假设某一术语在某一特殊的行文中利历时具有多种含义，那么应付该术语的每种含义做出说明并指出其适用处合。
b．完整性
需求分析报告应该包括全数成心义的需求，不管是关系到功能的、性能的、设计约束的、仍是关系到外部接口方面的需求；对所有可能显现的输入数据的响应予以概念，要对合法和非合法的输入值的响应做出规定；填写全数插图、表、图示标记等；概念全数术语和气宇单位。
c．可验证性
需求分析报告描述的每一个需求应是能够验证的。
能够通过一个有限处置进程来检查软件产品是不是知足需求。
d．一致性
在需求分析报告中的各个需求的描述不能相互矛盾。
e．可修改性
需求分析报告应具有一个有条不紊、易于利用的内容组织；没有冗余，即同一需求不能在需求分析报告中显现多次。
f．可追踪性
每一个需求的源流必需清楚，在进一步产生和改变文件编制时，能够方便地引证每一个需求。
g．运行和保护时期的可利用性
需求分析报告必需知足运行和保护时期的需要。
在需求分析报告要写明功能的来源和目的。
3.1.2需求分析报告的编制者
需求分析报告应由交通局和开发者两边一起完成。
其中：
交通局负责依如实际需要提出希望软件实现的功能；软件开发者依照交通局提出的性能需求，结合软件开发编写需求分析。
3.1.3需求报告评审
在软件需求分析工作完成后，软件开发者应向交通局提交《软件需求分析报告》。
交通局组织有关人员对需求进行评审，以决定软件需求是不是完善和适当。
评审完成后，就能够够进入软件的设计时期。
3.1.4需求报告格式
《软件需求分析报告》需按必然的格式进行编写，具体的《软件需求分析报告》文档编写模板请见附录A。
3.2软件的概要设计
3.2.1概要设计
在交通局和开发者两边认可的《需求分析报告》基础上，开发者进行下——步的工作。
第一，开发者需要对软件系统进行概要设计，即系统设计。
概要设计需要对软件系统的设计进行考虑，包括系统的大体处置流程、系统的组织结构、模块划分、功能分派、接口设计、运行设计、数据结构设计和犯错处置设计等，为软件的详细设计提供基础。
3.2.2编写概要设计的要求
a．一致性
概要设计的要求应该与需求分析报告所描述的需求一致。
同时，概要设计的各项要求之间也应该一致。
b．合理性
概要设计所提出的设计方式和标准应该是合理的、适当的。
c．可追踪性
对概要设计所提出的各项要求应该能够取得它的清楚的源流，即在需求分析报告客户有明确的需求描述。
d．可行性
依照概要设计进行详细设计、操作和保护应该是可行的。
3.2.3概要设计报告的编写者
概要设计报告由开发者依照需求分析报告的要求进行编写。
3.2.4概要设计和需求分析、详细设计之间的关系和区别
需求分析不涉及具体的技术实现，而概要设计注重于从宏观上和框架上来描述采纳何种技术手腕、方式来实现这些需求。
详细设计相对概要设计更注重于微观上和框架内的设计，是编码的依据。
概要设计是指导详细设计的依据。
3.2.5概要设计的评审
在软件概要设计工作完成后，软件开发者应向交通提交《软件系统概要设计报告》。
在交通局对《概要设计报告》评审通事后，即可进入详细设计时期。
3.2.6概要设计格式
《软件系统概要设计报告》需按必然的格式进行编写，具体的《软件系统概要设计报告》文档编写模板请见附录B。
3.3软件的详细设计
3.3.1详细设计
在概要设计的基础上，开发者需要进行软件系统的详细设计。
在详细设计中，描述实现具体模块所涉及到的要紧算法、数据结构、类的层次结构及挪用关系，需要说明软件系统各个层次中的每一个程序（每一个模块或子程序）的设计考虑，以便进行编码和测试。
应当保证软件的需求完全分派给整个软件。
详细设计应当足够详细，能够依照详细设计报告进行编码。
3.3.2特例
若是软件系统比较简单，层次较少，能够没必要进行专门的详细设计，而和概要设计结合起来。
3.3.3详细设计的要求
a．一致性
详细设计的要求应该与需求分析报告所描述的需求、与概要设计一致。
同时，详细设计的各项要求之间也应该是一致的。
b．合理性
详细设计所提出的设计方式和标准应该是合理的、适当的。
c．可追踪性
对详细设计所提出的各项要求应该能够取得它的清楚的源流，即可在需求分析报告、概要设计报告中有明确的需求描述。
d．可行性
依照详细设计进行编码、测试、操作和保护应该是可行的。
3.3.4数据库设计
若是软件产品需要利用到数据库，软件的详细设计应包括对数据库的设计。
数据库设计应在软件的需求分析、概要设计完成以后、详细设计的其它工作之前进行。
在进行数据库设计时，应当依照交通局制定的《南京市交通局信息化数据库建设标准》要求进行。
3.3.5详细设计的评审
在软件详细设计完成后，软件开发者应向交通局提交《软件系统数据库设计报告》和《软件系统详细设计报告》。
在交通局对《软件系统数据库设计报告》、《软件系统详细设计报告》评审通事后，即可进入软件编码时期。
3.3.6详细设计格式
《软件系统详细设计报告》、《软件系统数据库设计报告》需按必然的格式进行编写，具体的《软件系统详细设计报告》文档编写模板和《软件系统数据库设计报告》文档编写模板请见附录C、附录D。
3.4软件的编码
3.4.1软件编码
在软件编码时期，开发者依照《软件系统详细设计报告》中对数据结构、算法分析和模块实现等方面的设计要求，开始具体的编写程序工作，别离实现各模块的功能，从而实现对目标系统的功能、性能、接口、界面等方面的要求。
3.4.2软件编码的要求
a．模块化编码
b．代码可读性
c．可保护性
d．模块接口标准化
e．界面风格统一
e．注释的应用
3.4.3编码的评审
为了及早发觉软件中的障碍，提高软件产品的质量，开发者在编码的进程中应该强调代码评审工作。
将代码评审报告作为文档的一部份，提交给交通局。
3.4.4编程标准及要求
为了提高编程实现的质量，软件的程序设计必需遵循国家公布的相关编程标准。
要紧内容包括：
标准化的程序内部文档、数据结构的详细说明、清楚的语句结构、编码标准。
编码标准的内容包括命名标准、界面标准、提示及帮忙信息标准、热键概念等。
其中数据库部份应遵守《南京市交通局信息化数据库建设标准》的要求。
在软件编码的同时应进行单元测试。
3.5软件的测试
3.5.1软件测试
为了及早发觉软件产品中的错误，从而达到提高软件质量、降低软件保护的费用，开发者应在编码进程中对各个模块的程序代码进行单元测试，系统集成时进行集成测试，系统集成完成后对整个软件进行系统测试。
单元测试是在软件开发进程中针对程序模块进行正确性查验。
集成测试是在单元测试的基础上，将所有模块依照设计要求组装成系统或子系统，对模块组装进程和模块接口进行正确性查验。
软件系统测试不仅是检测软件的整体行为表现，从另一个侧面看，也是对软件开发设计的再确认。
进行软件系统测试工作时。
测试要紧包括界面测试、可用性测试、功能测试、稳固性（强度）测试、性能测试、强壮性（恢复）测试、逻辑性测试、破坏性测试、平安性测试等。
开发者针对单元测试，集成测试，系统测试别离制定《测试打算》。
集成测试需要依照需求分析报告和概要设计制作测试用例，并须通过评审。
软件测试依照《测试打算》、《需求分析报告》的要求进行，最后形成《软件测试报告》。
3.5.2测试打算
在软件编码开始之前，开发者应向交通局提交《测试打算》，在软件交付时，开发者应向交通局提交《软件测试报告》，以确保开发者的软件取得了充分的测试。
开发的软件必需通过充分的测试证明其符合设计要求、运行稳固、平安可用方可交付交通局。
3.6软件的交付预备
3.6.1交付清单
在软件测试证明软件达到要求后，软件开发者应向交通局提交开发的目标安装程序、数据库的数据字典、《用户安装手册》、《用户利用指南》、需求报告、设计报告、测试报告等两边合同约定的产物。
《用户安装手册》应详细介绍安装软件对运行环境的要求、安装软件的概念和内容、在客户端、效劳器端及中间件的具体安装步骤、安装后的系统配置。
《用户利用指南》应包括软件各项功能的利用流程、操作步骤、相应业务介绍、特殊提示和注意事项等方面的内容，在需要时还应举例说明。
3.7软件的鉴定验收
3.7.1软件的鉴定验收
在软件开发完成后，为了确保软件是依照需求分析的要求进行开发的，保证软件产品的质量，需要对软件产品进行鉴定验收。
在开发者如期交付软件后，由交通局负责确信具体的鉴定验收日期。
3.7.2验收人员
由交通局聘请具有必然的分析、设计、编程和软件测试体会的验收组长和其他专业人员组成。
验收组设组长一名（可设有副组长），负责整个验收的打算、组织工作。
3.7.3验收具体内容
验收内容应该包括：
合法性检查、文档检查、软件一致性检查、软件系统测试与测试结果评审等几项工作。
合法性检查检查软件开发工具是不是合法、利用的函数库、控件、组件是不是有合法的发布许可。
文档检查检查开发者提交的文档必需齐全，质量是不是过关。
需要开发者提供的文档包括：
项目实施打算；
详细技术方案；
软件需求规格说明书（STP）（含数据字典）；
概要设计说明书（PDD）；
详细设计说明书（DDD）（含数据库设计说明书）；
软件测试打算（STP）（含测试用例）；
软件测试报告（STR）；
用户手册（SUM）（含操作、利用、保护、应急处置手册）；
源程序（SCL）（不可修改的电子文档）；
项目实施打算（PIP）；
项目开发总结（PDS）；
软件质量保证打算（SQAP）；
另外，验收组能够依照需要对其它文档（如软件配置打算、项目进展报表、时期评审报表等）进行检查。
文档的质量依照完备性、正确性、简明性、可追踪性、自说明性、标准件等方面进行踪合评定。
验收需要对软件代码进行检查，以确保其符合标准，并检查其一致性。
3.7.4软件验收测试大纲
在软件进行鉴定验收前，开发者需依照必然的格式编写《软件验收测试大纲》，具体的格式请见附录E。
3.8培训
3.8.1系统应用培训
要紧培训内容包括：
系统操作利用、业务治理流程。
培训对象：
应用操作人员。
3.8.2系统治理的培训（可选）
要紧培训内容包括：
系统安装、调试、保护；系统治理。
培训对象：
系统治理人员。
开发者应详细列出培训打算，包括培训内容、教材、时刻和人员等。
附录A软件需求分析报告文档模板
4.引言
引言是对这份软件产品需求分析报告的概览，是为了帮忙阅读者了解这份文档是如何编写的，而且应该如何阅读、明白得和说明这份文档。
4.1编写目的
说明这份软件产品需求分析报告是为哪个软件产品编写的，开发那个软件产品意义、作用、和最终要达到的用意。
通过这份软件产品需求分析报告详尽说明了该软件产品的需求规格，包括修正和（或）发行版本号，从而对该软件产品进行准确的概念。
若是这份软件产品需求分析报告只与整个系统的某一部份有关系，那么只概念软件产品需求分析报告中说明的那个部份或子系统。
4.2项目风险
具体说明本软件开发项目的全数风险承担者，和各自在本时期所需要承担的要紧风险，首要风险承担者包括：
●任务提出者；
●软件开发者；
●产品利用者。
4.3文档约定
描述编写文档时所采纳的标准（若是有标准的话），或各类排版约定。
排版约定应该包括：
●正文风格；
●提示方式；
●重要符号；
也应该说明高层次需求是不是能够被其所有细化的需求所继承，或每一个需求陈述是不是都有其自己的优先级。
4.4预期读者和阅读建议
列举本软件产品需求分析报告所针对的各类不同的预期读者，例如，可能包括：
●用户；
●开发人员；
●项目领导；
●营销人员；
●测试人员；
●文档编写入员。
而且描述了文档中，其余部份的内容及其组织结构，而且针对每一类读者提出最适合的文档阅读建议。
4.5产品范围
说明该软件产品及其开发目的的简短描述，包括利益和目标。
把软件产品开发与企业目标，或业务策略相联系。
描述产品范围时需注意，能够参考项目视图和范围文档，可是不能将其内容复制到那个地址。
4.6参考文献
列举编写软件产品需求分析报告时所用到的参考文献及资料，可能包括：
●本项目的合同书；
●上级机关有关本项目的批文；
●本项目已经批准的打算任务书；
●用户界面风格指导；
●开发本项目时所要用到的标淮；
●系统规格需求说明；
●利用实例文档；
●属于本项目的其它己发表文件；
●本软件产品需求分析报告中所引用的文件、资料；
●相关软件产品需求分析报告；
为了方便读者查阅，所有参考资料应该按必然顺序排列。
若是可能，每份资料都应该给出：
●标落款称；
●作者或合同签约者；
●文件编号或版本号；
●发表日期或签约日期；
●出版单位或资料来源。
5.综合描述
这一部份概述了正在概念的软件产品的作用范围和该软件产品所运行的环境、利用该软件产品的用户、对该软件产品己知的限制、有关该软件产品的假设和依托。
5.1产品的状况
描述了在软件产品需求分析报告中所概念的软件产品的背景和起源。
说明了该软件产品是不是属于以下情形：
●是不是是产品系列中的下一成员；
●是不是是成熟产品所改良的下一代产品；
●是不是是现有应用软件的替代品（升级产品）；
●是不是是一个新型的、自主型的产品。
若是该软件产品需求分析报告概念的软件系统是：
●大系统的一个组成部份；
●与其它系统和其它机构之间存在大体的彼此关系。
那么必需说明软件产品需求分析报告概念的这部份软件是如何与整个大系统相关联的，或（同时）说明彼此关系的存在形式，而且要概念出二者之间的全数接口。
5.2产品的功能
因为将在需求分析报告的第4部份中详细描述软件产品的功能，因此在此只需要概略地总结。
仅从业务层面陈述本软件产品所应具有的要紧功能，在描述功能时应该针对每一项需求准确地描述其各项规格说明。
若是存在引发误解的可能，在陈述本软件产品要紧功能的作用领域时，也需要对应陈述本软件产品的非作用领域，以利读者明白得本软件产品。
为了专门好地组织产品功能，使每一个读者都容易明白得，能够采纳列表的方式给出。
也能够采纳图形方式，将要紧的需求分组和它们之间的联系利用数据流程图的顶层图或类图进行表示，这种表示方式是很有效的。
参考用户当前治理组织构架，了解各个机构的要紧职能，将有助于陈述软件产品的要紧功能。
5.3用户类和特性
确信有可能利用该软件产品的不同用户类，而且描述它们相关的特点。
往往有一些软件需求，只与特定的用户类有关。
描述时，应该将该软件产品的重要用户类与非重要用户类区分开。
用户不必然是软件产品的直接利用者，通过报表、应用程序接口、系统硬件接口取得软件产品的数据和效劳的人、或机构也有他们的需求。
因此，应该将这些外部需求视为通过报表、应用程序接口、系统硬件接口附加给软件产品的附加用户类。
5.4运行环境
描述了本软件的运行环境，一样包括：
●硬件平台；
●操作系统和版本；
●支撑环境（例如：
数据库等）和版本；
●其它与该软件有关的软件组件；
●与该软件共存的应用程序。
5.5设计和实现上的限制
确信阻碍开发人员自由选择的问题，而且说明这些问题什么缘故成为一种限制。
可能的限制包括以下内容：
●必需利用的特定技术、工具、编程语言和数据库；
●幸免利用的特定技术、工具、编程语言和数据库；
●要求遵循的开发标准和标准
例如，若是由客户的公司或第三方公司负责软件保护，就必需概念转包者所利用的设计符号表示和编码标准；
●企业策略的限制；
●政府法规的限制；
●工业标准的限制；
●硬件的限制
例如，按时需求或存储器限制；
●数据转换格式标淮的限制。
5.6假设和约束（依托）
列举出对软件产品需求分析报告中，阻碍需求陈述的假设因素（与己知因素相对立）。
若是这些假设因素不正确、不一致或被修改，就会使软件产品开发项目受到阻碍。
这些假设的因素可能包括：
●打算利用的商业组件，或其它软件中的某个部件；
●假定产品中某个用户界面将符合一个特殊的设计约定；
●有关本软件用户的假设干假定（例如：
假定用户会熟练利用SQL语言。
）；
●有关本软件开发工作的假设干假定（例如：
用户许诺的优惠、方便、上级部门给予的特殊政策和支持等。
）；
●有关本软件运行环境的一些问题；
另外，确信本软件开发项目对外部约束因素所存在的依托。
有关的约束可能包括：
●工期约束；
●经费约束；
●人员约束；
●设备约束；
●地理位置约束；
●其它有关项目约束；
6.外部接口需求
通过本节描述能够确信，保证软件产品能和外部组件正确连接的需求。
关联图仅能表示高层抽象的外部接口，必需对接口数据和外部组件进行详细描述，而且写入数据概念中。
若是产品的不同部份有不同的外部接口，那么应该把这些外部接口的全数详细需求并入到这一部份实例中。
注意：
必需将附加用户类的特点与外部接口需求加以区分，附加用户类的特点描述的是通过接口取得软件产品的数据和效劳的人的需求；而外部接口需求描述的是接口本身的需求。
6.1用户界面
陈述需要利用在用户界面上的软件组件，描述每一个用户界面的逻辑特点。
必需注意，那个地址需要描述的是用户界面的逻辑特点，而不是用户界面。
以下是可能包括的一些特点：
●将要采纳的图形用户界面（GUl）标准或产品系列的风格；
●有关屏幕布局或解决方案的限制；
●将要利用在每一个屏幕（图形用户界面）上的软件组件，可能包括：
选单；
标准按钮；
导航链接；
各类功能组件；
消息栏；
●快捷键；
●各类显示格式的规定，可能包括：
不同情形下文字的对齐方式；
不同情形下数字的表现格式与对齐方式
日期的表现方式与格式；
计时方式与时刻格式；
等等。
●错误信息显示标准；
关于用户界面的细节，例如：
一个特定对话框的布局，应该写入具体的用户界面设计说明中，而不能写入软件需求规格说明中。
若是采纳现成的、适合的用户界面设计标准（标准），或另文描述，能够在那个地址直接说明，而且将其加入参考文献。
6.2硬件接口
描述待开发的软件产品与系统硬件接口的特点，假设有多个硬件接口，那么必需全都描述。
接口特点的描述内容可能包括：
●支持的硬件类型；
●软、硬件之间交流的数据；
●操纵信息的性质；
●利用的通信协议；
6.3软件接口
描述该软件产品与其它外部组件的连接，这些外部组件必需明确它们的名称和版本号以资识别，可能的外部组件包括：
●操作系统；
●数据库；
●工具；
●函数库；
●集成的商业组件
说明：
那个地址所说的“集成的商业组件”，是指与系统集成的商业组件，而不是与软件产品集成的商业组件。
例如：
中间件、消息效劳，等等。
描述而且明确软件产品与软件组件之间互换数据或消息的目的。
描述所需要的效劳，和与内部组件通信的性质。
确信软件产品将与组件之间共享的数据。
若是
升级会员 