http://blog.sina.com.cn/gyjyys[订阅]
字体大小: 正文
节水系统开发指南(2008-07-10 09:08:55)

范围

本指南用于指导软件开发者为贵阳节水办开发软件项目的过程,通过规范软件项目承担单位的开发过程达到提高软件质量,降低维护成本的目的。开发者应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。在进行具体软件开发时,开发者可根据实际情况编写,但必须提供双方约定的文档,文档中约定的内容必须描述清楚。

1. 总体要求

1.1 总体功能要求

开发者应在充分分析需求的基础上,采用C/S结构。

本指南中规定开发者采用SQL Server进行开发。

1.2 软件开发平台要求

开发者开发的软件必须能够在节水办软硬件基础上正常运行。

1.3 软件项目的开发实施过程管理要求

1.3.1 软件项目实施过程总体要求

               (一)开发者提交软件开发工作大纲,节水办组织专家组对工作大纲进行评审,并提出整改意见。

               (二)通过评审后,开发者根据整改意见完善工作大纲,经过节水办认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行,在开发过程中,开发者需分阶段提交相关文档。

               (三)在软件开发工作完成后,开发者应向节水办提交完整的软件文档,节水办组织验收组对软件进行验收审查。

2. 软件开发

合同签订以后,项目承担单位即可组织项目组进行软件开发工作。软件开发必须严格按照软件工程的要求进行。开发过程包括开发者的活动和任务。此过程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。

2.1 软件的需求分析

2.1.1 需求分析

首先,开发者和节水办应共同对节水办的应用需求作充分的调研,提交完整的需求分析  报告。在需求分析报告中必须描述的基本问题是:功能、性能、强加于实现的设计限制、属 性、外部接口等。应当避免把设计或项目需求写入需求分析报告中。它必须说明由软件获得的结果,而不是获得这些结果的手段。

软件需求可以用若干种方法来表达,如通过输入、输出说明;使用代表性的例子;用规范化的模型。开发者应尽可能地使用模型的方式,因为这是表达复杂需求的精确和有效的方法。

编写需求分析报告的要求

a.无歧义性

对最终产品的每一个特性用某一术语描述;若某一术语在某一特殊的行文中使用时具有多种含义,那么应对该术语的每种含义做出解释并指出其适用场合。

b.完整性

需求分析报告应该包括全部有意义的需求,无论是关系到功能的、性能的、设计约束的、还是关系到接口方面的需求;对所有可能出现的输入数据的响应予以定义,要对合法和非合法的输入值的响应做出规定;填写全部插图、表、图示标记等;定义全部术语和度量单位。

c.可验证性

需求分析报告描述的每一个需求应是可以验证的。可以通过一个有限处理过程来检查软件产品是否满足需求。

d.一致性

在需求分析报告中的各个需求的描述不能互相矛盾。

e.可修改性

需求分析报告应具有一个有条不紊、易于使用的内容组织;没有冗余,即同一需求不能在需求分析报告中出现多次。

f.运行和维护阶段的可使用性

需求分析报告必须满足运行和维护阶段的需要。在需求分析报告要写明功能的来源和目的。

2.1.2 需求分析报告的编制者

需求分析报告应由节水办和开发者双方共同完成。其中:节水办负责根据实际需要提出希望软件实现的功能;软件开发者根据节水办提出的性能需求,结合软件开发编写需求分析。

2.1.3 需求报告评审

在软件需求分析工作完成后,软件开发者应向节水办提交《软件需求分析报告》。节水办组织有关人员对需求进行评审,以决定软件需求是否完善和恰当。评审完成后,就可以进入软件的设计阶段。

2.2 软件的概要设计

2.2.1 概要设计

在节水办和开发者双方认可的《需求分析报告》基础上,开发者进行下—步的工作。    首先,开发者需要对软件系统进行概要设计,即系统设计。概要设计需要对软件系统的设计    进行考虑,包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、接口设计、    运行设计、数据结构设计和出错处理设计等,为软件的详细设计提供基础。

2.2.2 编写概要设计的要求

a.一致性

概要设计的要求应该与需求分析报告所描述的需求一致。同时,概要设计的各项要求之间也应该一致。

b.合理性

概要设计所提出的设计方法和标准应该是合理的、恰当的。

c.可追踪性

对概要设计所提出的各项要求应该可以得到它的清晰的源流,即在需求分析报告客户有明确的需求描述。

d.可行性

根据概要设计进行详细设计、操作和维护应该是可行的。

2.2.3 概要设计报告的编写者

概要设计报告由开发者根据需求分析报告的要求进行编写。

2.2.4 概要设计和需求分析、详细设计之间的关系和区别

 需求分析不涉及具体的技术实现,而概要设计注重于从宏观上和框架上来描述采用何种技术手段、方法来实现这些需求。详细设计相对概要设计更注重于微观上和框架内的设计,    是编码的依据。概要设计是指导详细设计的依据。

2.2.5 概要设计的评审

在软件概要设计工作完成后,软件开发者应向节水办提交《软件系统概要设计报告》。在节水办对《概要设计报告》评审通过后,即可进入详细设计阶段。

2.2.6 概要设计格式

《软件系统概要设计报告》需按统一的格式进行编写。

2.3 软件的详细设计

2.3.1 详细设计

在概要设计的基础上,开发者需要进行软件系统的详细设计。在详细设计中,应当保证    软件的需求完全分配给整个软件。详细设计应当足够详细,能够根据详细设计报告进行编码。

2.3.2 特例

如果软件系统比较简单,层次较少,可以不必进行专门的详细设计,而和概要设计结合起来。

2.3.3 详细设计的要求

a.一致性

详细设计的要求应该与需求分析报告所描述的需求、与概要设计一致。同时,详细设计的各项要求之间也应该是一致的。

b.合理性

详细设计所提出的设计方法和标准应该是合理的、恰当的。

c.可追踪性

对详细设计所提出的各项要求应该可以得到它的清晰的源流,即可在需求分析报告、概要设计报告中有明确的需求描述。

d.可行性

根据详细设计进行编码、测试、操作和维护应该是可行的。

2.4 软件的编码

2.4.1 软件编码

在软件编码阶段,开发者根据《软件系统详细设计报告》中对数据结构、算法分析和模块实现等方面的设计要求,开始具体的编写程序工作,分别实现各模块的功能,从而实现对目标系统的功能、性能、接口、界面等方面的要求。

2.4.2 软件编码的要求

a.模块化编码

b.代码可读性

c.可维护性

d.界面风格统一

e.注释的应用

2.4.3 编码的评审

为了尽早发现软件中的障碍,提高软件产品的质量,开发者在编码的过程中应该强调代码评审工作。将代码评审报告作为文档的一部分,提交给节水办。

2.4.4 编程规范及要求

为了提高编程实现的质量,软件的程序设计必须遵照国家颁布的相关编程规范。

主要内容包括:规范化的程序内部文档、数据结构的详细说明、清晰的语句结构、编码规范。编码规范的内容包括命名规范、界面规范、提示及帮助信息规范、热键定义等。

2.5 软件的测试

2.5.1 软件测试

为了尽早发现软件产品中的错误,从而达到提高软件质量、降低软件维护的费用,开发者应在编码过程中对各个模块的程序代码进行单元测试,系统集成时进行集成测试,系统集成完成后对整个软件进行系统测试。单元测试是在软件开发过程中针对程序模块进行正确性检验。软件系统测试不仅是检测软件的整体行为表现,从另一个侧面看,也是对软件开发设计的再确认。进行软件系统测试工作时。测试主要包括界面测试、可用性测试、功能测试、稳定性(强度)测试、性能测试、强壮性(恢复)测试、逻辑性测试、破坏性测试、安全性测试等。

开发者针对测试制定《测试计划》。集成测试需要根据需求分析报告和概要设计制作测试用例,并须经过评审。软件测试按照《测试计划》、《需求分析报告》的要求进行,最后形成《软件测试报告》。

2.5.2 测试计划

在软件编码开始之前,开发者应向节水办提交《测试计划》,在软件交付时,开发者应向节水办提交《软件测试报告》,以确保开发者的软件得到了充分的测试。开发的软件必须经过充分的测试证明其符合设计要求、运行稳定、安全可用方可交付节水办。

2.6 软件的交付准备

2.6.1 交付清单

在软件测试证明软件达到要求后,软件开发者应向节水办提交开发的目标安装程序、数据库的数据字典、《用户安装手册》、《用户使用指南》、需求报告、设计报告、测试报告等约定的产物。

《用户安装手册》应详细介绍安装软件对运行环境的要求、安装软件的定义和内容、在客户端、服务器端及中间件的具体安装步骤、安装后的系统配置。

《用户使用指南》应包括软件各项功能的使用流程、操作步骤、相应业务介绍、特殊提示和注意事项等方面的内容,在需要时还应举例说明。

2.7 软件的鉴定验收

2.7.1 软件的鉴定验收

在软件开发完成后,为了确保软件是按照需求分析的要求进行开发的,保证软件产品的质量,需要对软件产品进行鉴定验收。在开发者如期交付软件后,由节水办负责确定具体的鉴定验收日期。

2.7.2 验收具体内容

验收内容应该包括:合法性检查、文档检查、软件一致性检查、软件系统测试与测试结果评审等几项工作。

文档检查检查开发者提交的文档必须齐全,质量是否过关。需要开发者提供的文档包括:

项目实施计划;

详细技术方案;

软件需求规格说明书(STP)(含数据字典);

概要设计说明书(PDD);

详细设计说明书(DDD)(含数据库设计说明书);

软件测试计划(STP)(含测试用例);

软件测试报告(STR);

用户手册(SUM)(含操作、使用、维护、应急处理手册);

源程序(SCL)(不可修改的电子文档);

项目实施计划(PIP);

项目开发总结(PDS);

软件质量保证计划(SQAP);

2.8 培训

2.8.1 系统应用培训

主要培训内容包括:系统操作使用、业务管理流程。

培训对象:应用操作人员。

2.8.2 系统管理的培训(可选)

主要培训内容包括:系统安装、调试、维护;系统管理。

培训对象:系统管理人员。

开发者应详细列出培训计划,包括培训内容、教材、时间和人员等。

 

  附录一为节水管理系统基本功能模块

加载中,请稍候...
  • 评论加载中,请稍候...

验证码:请点击后输入验证码  收听验证码

发评论

以上网友发言只代表其个人观点,不代表新浪网的观点或立场。

相关博文
读取中...
推荐博文
读取中...