H银行系统软件工程文档管理制度

XX银行软件工程文档管理制度规定
V 1.0
文档控制
版本控制
1软件过程规范
过程规范是软件过程管理中的重要工作内容，是软件开发组织行动应遵循的准则与指南。

项目开发过程、需求管理过程和配置管理过程联系紧密，是顺利完成软件项目的重要保障。

1.1开发过程规范
XX银行总行及各分支在实施新的项目开发和软件升级计划时必须按照需求分析、设计、编码、测试和验收的过程执行。

1.2需求管理过程规范
有效控制需求变更并减少需求变更对项目的影响。

制定详细的需求变更管理流程，保证实际进行的变更过程更有规律，且可控制。

1.3配置管理过程规范
XX银行总行及各分支软件项目在开发过程中产生大量的资料（如各种文档、程序、数据和手册），为避免项目在变更时失控，必须进行正确的控制和管理。

配置管理需要加强版本控制。

必须正确跟踪软件开发过程中的各种中间成果、其它版本以及软件的版本。

这个活动需要与开发过程相区别，在实践中逐渐完善成一个独立的、科学的配置管理过程。

1.4附件
附件包括各种文档与工作指南。

所有附件应以单独的文档形式存储。

2需求分析规范
需求分析规范用来规定XX银行总行及各分支软件需求分析阶段的任务、过程和相关要求，以及需求分析阶段的完成标志，适用于软件需求分析阶段的所有任务和相关人员，包括项目管理人员、软件需求分析人员、文档编制人员和质量审核人员。

2.1需求分析的任务和过程
2.1.1需求分析的任务
确定被开发软件的运行环境、功能、性能和数据需求，建立确认测试准则，编写用户手册，为概要设计提供需求说明书。

2.1.2需求分析的过程
需求分析过程需要分成下列步骤，循序渐进地展开：
a.确定需求分析方法和工具；
b.人员培训；
c.确定需求分析输入；
d.需求分析；
e.制定确定测试计划；
f.修改开发计划；
g.编制文档；
h.需求分析审查；
i.需求分析文档存档。

2.2总体要求
a.软件需求分析应该有XX银行总行及各分支指定的业务和技术人员参加；
b.需求说明必须明确，经过项目组同意，并用合适的方式予以确认；
c.应以能够理解的形式和术语来规范需求的描述，以利于沟通。

2.3需求分析流程
2.3.1确定需求分析方法和工具
选定合适的需求分析方法，在同一个软件项目内所用的分析方法应该保持一致性。

建议使用的候选分析方法为：
a.结构分析方法，包括面向数据流的分析方法和面向数据结构的分析方法。

b.面向对象的分析方法。

在需求分析方法选定后，应确定支持该方法的工具。

在同一个软件项目内，需求建模语言和工具应该保持一致性和规范性，同时必须对需求人员进行所选定的设计方法、工具以及相关标准的培训。

2.3.2确定需求分析输入
需求分析的输入应包括下列资料：
a.可行性研究报告；
b.项目开发计划；
c.相关的用户资料，例如，用户工作手册、相关行业的技术规范、相关的法律文件等；
d.现有同类系统的资料；
e.软件需求分析相关的标准化文件，如：软件需求分析规范，软件需求说明书规范，测试规范等。

2.4需求分析
需求分析必须包括下列过程：
a.初步需求获取；
b.需求建模。

即建立目标软件系统的模型。

模型的表示机制应具备良好的结构化能力；
c.需求评审。

对需求说明书的正确性、无歧义性、完全性、可验证性、一致性、可理解性、可修改性和可追踪性等特性进行评价。

对评审过程中发现的错误或缺陷，应及时进行修正和补充。

2.5编写文档
必须按标准的文档格式编制下列文档：
a.软件需求说明书；
b.数据需求说明书（可包含在软件需求说明书中）；
c.确认测试计划：
d.修改的开发计划；
e.用户手册概要。

2.6需求评审
需求评审至少应涉及以下两个方面：
a.文档审查，以保证文档的正确性，以及格式是否标准。

b.需求分析过程审查，检查需求分析过程是否符合开发规范。

3系统分析设计规范
3.1系统设计
系统设计是软件开发过程中的重要阶段，实现从计算机实现的逻辑角度开发针对软件需求的方案。

系统设计必须设计出各主要部分，并指出技术上的工作机制：a.相互间的协作；b.所需外在的硬件和软件环境；c.内在环境。

系统设计的入口准则是《软件需求说明书》已通过确认；出口准则是形成系统设计，实现任务分解，所有的问题得到解决，也即输出的是《系统设计说明书》（功能与数据库设计）、详细设计、编码、文档和用户接口标准。

3.1.1总体设计
3.1.1.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求。

3.1.1.2运行环境
简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。

3.1.1.3基本设计概念和处理流程
说明本系统的基本设计概念和处理流程，应尽量使用图表的形式。

3.1.1.4结构
给出系统结构总体框图（包括软件、硬件结构框图），说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。

3.1.1.5功能需求与系统模块的关系
说明各项功能需求的实现同各模块的分配关系。

3.1.1.6人工处理过程
说明在软件系统的工作过程中不得不包含的人工处理过程。

3.1.1.7尚未解决的问题
说明在概要设计过程中尚未解决而在软件系统完成之前必须解决的各个问题。

3.1.2接口设计
3.1.2.1用户接口
说明提供的命令和语法结构以及相应的回答信息。

3.1.2.2外部接口
说明同外界的所有接口的安排，包括软件与硬件之间的接口、与各支持软件之间的接口关系。

3.1.2.3内部接口
说明各个系统元素之间的接口的安排。

3.1.3系统数据结构设计
应严格进行数据逻辑结构和物理结构设计，并明确界定数据结构与程序的关系。

3.2详细设计
详细设计阶段的工作内容包括通用例程和程序的确定、框架程序的开发以及用于提高开发效率的实用程序和工具的开发。

在详细设计阶段必须实现每个程序、模块（或构件）的内部设计，确定其程序流程，并且通过使用设计语言、图形流程图或通过简单地写叙述而将设计文档化。

详细设计的入口准则是《系统设计说明书》已通过评审；出口准则是完成详细设计，所有的问题得到解决，详细设计与单元测试计划文档化。

也即，详细设计的输入是《软件需求规格说明书》、《系统设计说明书》和详细设计标准，而输出的是《详细设计说明书》和《单元测试计划》。

详细设计具体内容应包括：
a.模块描述。

给出对该基本模块的简要描述，主要说明安排设计该模块的目的意义以及其特点；
b.功能。

说明该基本模块应具有的功能；
c.性能。

说明对该模块的全部性能要求；
d.输入项。

给出对每一个输入项的特性；
e.输出项。

给出对每一个输出项的特性；
f.设计方法（算法）。

对于软件设计，应详细说明所选取用的算法、具体的计算公式及计算步骤；
g.流程逻辑。

用图表辅以必要的说明来表示逻辑流程；
h.接口。

说明相关模块间的逻辑连接方式以及涉及到的参数传递方式；
i.存储分配。

根据需要，说明其存储分配方案；
j.注释设计。

说明程序注释；
k.限制条件。

说明在运行使用中所受到的限制条件；
l.测试计划。

说明进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件；
m.尚未解决的问题。

说明在设计中尚未解决而必须在系统完成之前应解决的问题。

4界面设计规范
4.1用户界面设计原则
界面设计必须明确：最终用户的需求是界面设计的核心，用户界面应当由最终用户来控制应用如何工作、如何响应。

界面设计必须经过系统应用人员的确认才能确定完成与否。

4.2界面一致性
在界面设计中应该遵循显示信息一致性原则、布局合理化原则、鼠标与键盘对应原则和快捷键应用原则。

4.3系统响应时间
系统响应时间应考虑两方面内容：时间长度的控制和时间的易变性。

4.4用户帮助设施
常用的帮助设施应以集成的帮助设施和附加的帮助设施两种方式共同实现。

4.5出错信息和警告
对于出错信息和警告应该遵循以下原则：
a.信息的术语描述应具有易理解性；
b.信息应提供进行恢复的建设性意见；
c.信息应指出错误可能导致的不量后果，以便于检查问题是否出现并有利于改正。

4.6数据输入原则
数据输入应遵循以下原则：
a.尽量减少最终用户的数据输入量；
b.交互应具有灵活性，支持全键盘输入；
c.为需要解释的操作行为提供帮助；
d.消除冗余输入，尽量提供缺省值。

5软件编码规范
软件编码阶段应产生源代码、可执行代码，其输出是随后测试和验证的主体。

软件编码要遵循以下原则：
a.遵循开发流程，在设计的指导下进行代码编写；
b.代码的编写应以实现设计的功能和性能为目标，要求正确完成设计要求的功能，达到设计的性能；
c.程序应具有良好的程序结构，提高程序的封装性好，减低程序的耦合程度；
d.程序应具有好的可读性，易于理解，方便调试和测试；
e.程序应易于维护，具备良好的可修改性和可扩充性；
f.尽量少的占用系统资源，在不降低程序质量的前提下尽量提高代码的执行效率。

6软件测试规范
6.1测试计划
6.1.1确定测试的目标和策略
确定输出测试计划，明确要完成的测试活动，评估完成测试活动所需要的时间和资源，设计测试组织和岗位职责，进行工作安排和资源分配。

6.1.2测试计划的内容
测试计划应具备测试计划、测试设计说明、测试规程、测试用例等四个部分的内容。

6.2测试设计
根据测试计划设计测试方案。

测试设计过程要实现两项工作：
a.输出各测试阶段的测试用例；
b.确定回归测试的用例集。

6.3测试实施
使用测试用例运行被测试程序，将获得的运行结果与期望结果进行比较和分析，记录、跟踪和管理软件错误和缺陷，最后得到软件错误数据库和测试报告。

6.4测试管理
测试管理应包括软件测试的组织管理、测试质量管理、测试进度和资源管理、测试文档管理以及测试数据的统计与积累。

测试管理工作应由参与测试工作的各组成员共同进行。

6.5测试报告
测试完成后应提交综合测试报告和验收测试报告。

7软件验收规范
7.1工作内容
a.执行和分析验收测试；
b.整理文档；
c.完成相关培训；
d.确定有关接收的事宜。

7.2文档验收内容
文档验收工作应包括以下相关文档：
a.项目管理类文档：《软件项目计划》、《项目进度周报》、《项目总结》、《项目绩效考核表》、《项目计划变更表》、《软件配置
管理计划》；
b.开发过程类文档：《软件需求规格说明书》、《系统设计说明书》、《详细设计说明书》、《单元测试计划》、《单元测试报告》、《集成计划》、《集成测试计划》、《集成测试报告》、《系统测试计划》、《系统测试报告》、《验收测试报告》；
c.工作指南类文档：《软件需求分析工作要求》、《软件项目计划工作要求》、《软件需求管理工作要求》、《软件配置管理工作要求》；
d.应用类文档：《培训手册》、《用户操作手册》
2006-10-11。