软件工程中的设计文档核心模块.docx
《软件工程中的设计文档核心模块.docx》由会员分享，可在线阅读，更多相关《软件工程中的设计文档核心模块.docx（44页珍藏版）》请在冰点文库上搜索。
软件工程中的设计文档核心模块
设计文档
一．开发文档
项 目 计 划
序号：
项目名称 ：
执行部门：
负责人：
项目类别 [ ] 软科学研究项目 [ ] 科研开发项目 [ ] 工程推广项目 [ ]
工程开发项目 [ ] 系统集成项目 [ ] 服务项目 []其他[]
项目起止日期 从200 年 月 日 至200 年 月 日
项目合同额 合同号 项目代号
计划完成时间 修改时间 第 次修改
1.项目概述
2.项目阶段划分：
项目阶段 主要任务 人数 / 单位 起止时间 输入 / 输出
3.项目组织
3.1 项目参加人员：
姓 名 所在部门或单位 职称/学历 技术岗位
本单位 外单位
3.2 技术岗位分配
技术岗位 人 员 人 数 负责人
需求分析员
系统设计员
程序员
测试员
配置管理员
3.3 项目组织管理说明
4. 所需环境条件：
硬件平台
实验环境所需设备
设备用途
现有设备 需增加设备
软件平台
实验环境所需软件平台
软件用途
现有条件 需增加软件
5. 资源分配
任 务 起止时间 人 员 所需设备
6. 计划进度安排
7.项目成本预算
时间阶段 年
第1季度 年
第2季度 年
第3季度 年
第4季度
小计
合计
金额
器材费
设备购置费 设备名称 或代号 或细目
软件购置费 软件名称 或代号 或细目
专项业务费差旅费 资料费 会议费 办公费 业务费 其它费 劳务费
管理费
税金
小计
所有费用合计
注:
项目成本预算细目：
1．器材费 包括：
原材料费，设备购置及使用费
2．专项业务费 包括：
（1）差旅费（旅费、出租）（含补贴）
（2） 资料费（图书费、资料费、复印费、出版费）
（3） 邮电费（市话长话费、移动通信费、上网费、邮资）
（4） 会议费（培训、鉴定费、评审会、研讨费、外事费等）
（5） 广告宣传费
（6） 业务招待费
（7） 其他（检测、外加工费、维修费、消耗品、低易品、茶话会等）
3．劳务费（工资、奖金、补贴、住房基金、退休养老金）
4．管理费 （所管费、水、电、燃料、排污）
8．风险分析和处理
项目经理签字：
部门经理签字：
大部经理签字：
软件需求说明书
1． 引言
1.1 项目名称
1.2 项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.3 相关资料、缩略语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准等）
（缩写词和名词定义）
2. 任务概述
2.1 目标
（项目的开发目标和应用目标。
如果是其他系统的一部分，则说明其关系）
2.2 范围
（包含的业务，不包含的业务）
2.3 假定条件与约束限制
（尽量列出开展本项目的假定和约束，例如：
经费限制，开发期限，设备条件，用户现场环境准备等）
3．业务流程
4．数据描述
4.1 原始数据描述
a.静态数据
b. 动态数据
4.2 数据流向图
4.3 数据概念模型和描述
5．功能需求
5.1 功能描述
6．界面要求
6．1报表格式
6．2图形要求
6．3输入输出要求
7．接口要求
（描述与本系统相连的系统的接口的数据格式，数据交换协议，接口功能等）
8．性能需求
8．1数据精确度
（例如，数据内部精度，外部显示精度）
8．2数据量
8．3时间特性要求
（根据所开发系统的特点，规定系统对时间的特性的要求。
例如：
系统响应时间、界面更新处理时间、数据转换与传输时间）
9． 运行环境需求
9．1网络和硬件设备平台
（网络拓扑图及设备类型描述）
10.软件平台
操作系统平台 数据库系统平台
10.1编程工具
10.2其它支撑软件
11． 其它专门需求
11.1安装和操作
11.2安全保密
11.3维护服务
概要设计说明书
1.引言
1.1 项目名称
1.2项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.3相关资料、缩略语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准等） （缩写词和名词定义）
2.概要设计
2.1软件体系结构
（用图来表示软件系统的总体结构框架，并对其进行描述）
2.2基本设计概念和处理流程
2.3软件结构
1） 子系统划分
A） 子系统清单
B） 各子系统功能描述
2） 程序模块划分和功能分配
（包括前端程序模块和后端存储过程的划分和功能分配）
A） 子系统及程序模块清单
B） 各程序模块功能描述
C） 功能-模块对照表
D） 模块-数据实体对照表
3） 人工处理过程
（描述不能完全自动处理，需人工处理的过程。
例如：
在网管系统中，有些设备配置数据的提取需要人工干预。
在电信业务系统中，机线资源子系统中割接方案有些需人工输入）
3.软件模块的物理分布
（根据系统网络结构，描述软件模块在各个设备上的物理分布）
4. 接口设计
4.1与外系统的接口
4.2内部接口
5. 用户界面设计
（和用户交互的最终界面在《详细设计说明书》中设计解释，在此应对系统的主界面和界面设计风格进行设计和描述）
6. 数据结构和算法设计
6.1程序中数据结构描述
（描述系统中主要的数据结构和模块间共享的数据结构）
6.2 主要算法设计
7. 出错处理设计
7.1出错信息
（用一栏表的方式说明可能的出错和故障情况出现时，系统输出信息、形式和含义）
7.2出错处理措施
8. 安全保密设计
（描述安全保密方案，权限的设置，保密算法，软件的实现方法等）
详细设计说明书
1. 引言
1.1 项目名称
1.2项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.3相关资料、缩略语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准等）
（缩写词和名词定义）
2. 程序结构
2.1程序结构图
（主要表示程序间的调用关系）
2.2程序文件清单
子系统名 程序文件名 运行平台 编程语言 简要描述
3. 程序设计说明
程序文件名 子系统名
编写者 编写日期
第 次修改 修改人 修改日期
程序名称：
程序功能描述
输入/输出项
主要数据结构
存取的数据库表和字段
调用的其它程序
调用的公共函数库或公共函数
算法
逻辑流程图
测试要点
4．用户界面设计说明
4．1用户界面图
（可制作有关用户界面图集的附录参考）
4．2用户界面与模块关系表
用户界面名称 用户界面编号 隶属的子系统 相关模块名称 简要名称
软件开发过程控制程序
1 目的
为保证软件产品及其文档可维护，软件开发过程得到有效控制，特制定本程序。
2 适用范围
本程序文件适用于本公司有合同的所有软件开发过程的控制活动。
3 定义
3．1 需求分析：
（引用GB/T11457-1995的2.404）研究用户要求以得到系统或软件需求定义的过程。
3．2 概要设计：
（引用GB/T11457-1995的2.343）分析各种设计方案和定义软件体系结构的过程。
典型的概要设计包括计算机程序组成成分和数据的定义及构造、界面的定义，并提出时间和规模方面的估计。
3．3 详细设计：
（引用GB/T11457-1995的2.147）推敲并扩充概要设计，以获得关于处理逻辑、数据结构和数据定义的更加详尽的描述，直到设计完善到足以能实现的地步。
3．4 设计实现：
（引用GB/T11457-1995的2.229）把设计翻译成代码，然后对此代码排除隐错的过程。
它是程序的一种机器可执行形式，或者能被自动地翻译成机器可执行的形式的某种形式的程序。
4 职责
4． 1 项目负责人：
负责制订【项目计划】、协调项目内外各方的关系、控制项目进度并保证项目计划的实施和完成。
4．2 需求分析员：
作为开发方的代表，负责沟通用户和开发人员的认识和见解，明确及准确地编写【软件需求说明书】和初步的【系统指南】。
4． 3 系统设计员：
负责把软件需求变换成可表示的可实现的软件形式，为设计实现提供可行的依据。
并在设计过程中要负责编写【概要设计说明书】、【数据库设计说明书】、【详细设计说明书】，完成【系统指南】的编写。
4． 4 程序员：
按设计要求把软件的详细设计变换成可执行的源程序，进行调试。
完成相应的文档，编写【用户操作手册】。
4． 5 测试人员：
负责制定测试计划，设计测试方案，测试用例，并实施测试。
4． 6 配置管理人员负责对开发库中软件配置项的管理和维护。
5 工作程序
软件开发过程主要分为项目计划、需求分析、概要设计、详细设计、设计实现、内部测试和系统测试7个阶段。
5．1 项目计划
项目负责人负责制定项目计划。
在项目计划中要对项目的目标和时间要求给出明确的定义，要规定项目的组织和管理规则，项目的开发过程和输出要求，项目对资源的需求和分配等，详见《项目计划控制程序》。
5．2 制定开发规范
5．2．1 在项目开始后，项目负责人要组织有关人员讨论和确定实施该项目的技术路线，采用的开发方法论。
5．2．2 项目负责人要组织编写【XXX系统开发规范】，其中包括：
a. 阐述项目采用的技术路线；
b. 采用的软件开发方法和使用的软件辅助开发工具；
c. 制定需求分析阶段，设计阶段，编程阶段中文档编写规则，模型表示规则，命名约定等在开发过程中需协调一致的规则。
5．2．3 【XXX系统开发规范】中的一些详细规则可在开发过程中不断完善。
5．3 需求分析
5．3．1需求分析员应通过各种方式收集和获得所开发项目的业务需求，并对获取的需求和系统应具有的隐含需求进行分析，以建立系统的软件需求。
这些需求通常包括：
a. 功能需求
b. 数据需求
c. 性能需求
d. 人机接口需求
e. 安全和保密需求
f. 网络需求
g. 和其他系统的接口需求
h. 操作、维护和安装需求
i. 一些特殊的设计限制
5．3．2需求分析员要使用【XXX系统开发规范】中规定的需求分析方法和工具清晰准确地定义和描述这些需求。
编写【软件需求说明书】，编写初步的【系统指南】。
5．3．3【软件需求说明书】得到用户确认后，提交评审。
（参见《设计评审和设计更改控制程序》）。
5．4 概要设计
5．4．1 系统设计员应建立一个高层的软件体系结构，该体系结构应体现系统的需求。
该体系结构应描述软件的顶层结构和定义其主要部分,包括：
a. 整个软件系统的层次结构；
b. 每一层次的模块结构；
c. 相关模块间的接口, 即模块间传递信息的内容、方式和协议；
d. 确定各模块在计算机网络环境下的物理分布；
e. 确定系统的数据库结构；
f. 确定本软件系统与其他外围系统接口；
g. 确定模块与系统功能间的关系；
h. 确定模块与数据库表间的关系；
i. 考虑可靠性、安全性、灵活性等方面的设计；
j. 要确定用户界面的设计风格；
k. 主要算法设计；
l. 异常处理设计。
5．4．2 描述以上设计结果，编写【概要设计说明书】、【数据库设计说明书】和修改完善【系统指南】。
5．4．3将【概要设计说明书】和【数据库设计说明书】提交评审。
（参见《设计评审和设计更改控制程序》）
5．5 详细设计
5．5．1系统设计人员要深刻理解【概要设计说明书】，保证详细设计与概要设计相一致，为编码提供详尽的依据。
5．5．2细化和描述每一个功能模块，确定实现各个模块功能的具体算法、内部数据结构和外部接口方式。
5．5．3若功能模块涉及到用户界面，还要具体描绘出用户界面以及操作流程。
5．5．4编写【详细设计说明书】，修改完善【系统指南】。
5．5．5提交详细设计评审。
（参见《设计评审和设计更改控制程序》）
5．6 设计实现
5．6．1程序员应严格按照详细设计的说明，保证最终程序与详细设计相一致。
编码过程中应遵循【XXX系统开发规范】的命名规则和注释等规定保证程序的清晰、易读。
5．6．2程序员要对编写的程序进行调试，使程序不仅通过编译的语法检查，而且在功能和性能等方面达到设计的要求。
5．6．3编写【用户操作手册】，修改【系统指南】。
5．6．4 系统设计员最终完成【系统指南】。
5．7 内部测试
5．7．1项目负责人应组织系统的内部测试，内部测试由项目组内包括单元测试，集成测试和构造测试。
5．7．2项目组内的测试员负责编写系统内部测试的【测试计划】和【测试实例】，实施测试，填写【测试报告】。
测试部提供支持。
具体控制程序请参见《测试过程控制程序》。
5．8 系统测试
5．8．1系统通过内部测试后，项目负责人应向测试部提请系统测试。
5．8．2测试部负责编写系统测试的【测试计划】，【测试实例】，实施测试，填写【测试报告】。
项目测试员提供配合。
具体控制程序请参见《测试过程控制程序》。
5．9 软件配置管理过程
以上开发各个过程中产生计划、文档，程序都要纳入配置管理系统控制下。
详见《软件配置管理程序》。
6 引用文件
《项目计划控制程序》 （T.CX0401-A01）
《设计评审和设计更改控制程序》 （T.CX0403-A01）
《测试过程控制程序》 （T.CX1001-A01）
《配置管理控制程序》 （T.CX0801-A01）
7 技术文档
【XXX系统开发规范】
【软件需求说明书】
【概要设计说明书】
【数据库设计说明书】
【详细设计说明书】
【系统指南】
【用户操作手册】
8. 附录
软件生命周期各阶段要求输出的文档
阶段
文件 市场 调研 项目计划 需求分析 概要设计 详细设计 设计实现 内部测试 系统测试 工程安装 交付测试 软件维护
项目总体方案
可行性研究报告
项目计划
配置管理计划
系统开发规范
软件需求说明书
概要设计说明书
数据库设计说明书
详细设计说明书
系统指南
用户操作手册
用户培训教材
阶段
文件 市场调研 项目计划 需求分析 概要设计 详细设计 设计实现 内部测试 系统测试 工程安装 交付测试 软件维护
系统测试计划
交付测试计划
集成测试计划
构造测试计划
单元测试用例
集成测试用例
构造测试用例
系统测试用例
交付测试用例
单元测试报告
集成测试报告
构造测试报告
系统测试报告
交付测试报告
试运行文件中程序文件与质量记录的对应关系表
质量改进过程
程序文件名 质量记录
质量记录控制程序 / 生产支持过程：
程序文件名 质量记录
文件和资料控制程序 【受控文件清单】
【技术资料文件目录】
【文件更改申请单】
【文件更改记录】
【文件发放登记表】
【文件处理申请表】
【资料借阅登记表】
【受控文件丢失/损坏情况说明表】
不合格软件项控制程序 【软件项错误报告】
员工培训控制程序 【员工季度培训计划】
【培训申请表】
【员工培训登记表】
【培训考核记录】
开发生产过程：
程序文件名 质量记录
项目计划控制程序 【项目计划表】
【项目中期计划】
软件开发过程控制程序 【系统开发规范】
【软件需求说明书】
【概要设计说明书】
【数据库设计说明书】
【详细设计说明书】
【系统指南】
【用户操作手册】
设计评审和更改控制程序 【评审小组成员登记表】
【评审总结记录表】
【设计更改记录】
【开发产品文档审查报告】
【公司级设计评审申请表】
测试过程控制程序 【代码审查检查表】
【单元测试检查表】
【测试计划】
【测试用例说明】
【测试报告】
工程安装控制程序 【产品项清单】
【工程现场检验报告】
【产品修改记录表】
项目验收控制程序 【用户测试报告和验收报告】
【项目验收会议记录】
【产品交付清单】
【用户新需求表】
软件服务控制程序 【维护计划】
【用户意见征询表】
【用户意见处理通知书】
【用户意见反馈表】
【客户服务、技术支持中心热线服务统计表】
【培训计划】
【用户培训记录】
【用户培训反馈表】
项目计划控制程序
1. 目的
为保证公司内项目能够有计划、按步骤地实施，资源能够得到合理地分配和有效地利用，特制定本程序。
2. 适用范围
本程序适用于对软件开发或工程项目计划活动的控制。
3. 定义
3.1 资源：
开展项目活动的人力、物力和财力的总和。
4. 职责
4.1 项目负责人负责编制和修改【项目计划】，负责组织编制项目阶段计划，负责组织项目计划的实施。
4.2 项目组的配置管理员负责编制配置管理计划。
4.3 大部经理负责审查和批准本部门的【项目计划】和【项目中期计划】。
4.4 部门经理负责监督检查项目计划的执行和批准项目阶段计划。
5. 工作程序
5.1 项目计划编写总则
5.1.1项目负责人在接到项目后的首要任务是编制项目计划并组织相关计划的编写。
项目计划力求符合实际情况，切实能够指导项目实施的全过程。
5.1.2在项目计划阶段形成【项目计划】，若必须对【项目计划】进行修改，则修改后的项目计划形成【项目中期计划】。
【项目中期计划】可有多个，其格式同【项目计划】。
5.1.3 项目负责人应采用项目管理工具辅助项目管理工作。
5.1.4 项目计划主要包括如下内容：
a. 项目定义，包括项目名称，项目目标的描述，以及与之相关的前期项目和/或其他项目的目标及其关系描述；
b. 阶段划分，包括划分项目的工作阶段和确定各阶段的任务。
c. 项目的组织管理，包括项目组的人员构成、职责，技术岗位之间的组织的和技术的接口，管理方法，合作方的职责；
d. 项目使用的资源，包括人，财，物的需求和分配；
e. 项目进度，包括确定各项任务所需要的资源和时间，各任务之间的关系。
f. 风险分析，分析可能使计划延期的问题及其解决办法，和相应的计划修改方案。
g. 包含如下相关计划：
配置管理计划和项目阶段计划
5.2 项目的阶段划分
5.2.1 项目计划中要明确规定项目整个生存期内的工作阶段，每个工作阶段的输入和输出项。
这些工作阶段和输入/输出要求可根据项目情况，参照《配置管理程序》中的基线要求进行适当剪裁。
5.2.2 细化并列出每个工作阶段的具体任务，任务描述和输出要求。
5.3 项目的组织和管理
5.3.1 一个软件开发项目中至少由如下技术岗位构成：
a. 需求分析员
b. 系统设计员
c. 程序员
d. 测试员
e. 配置管理员
项目计划必须明确规定每个人的技术岗位。
5.3.2 一个工程安装项目至少由如下技术岗位构成：
a. 售前工程师
b. 系统集成工程师（如果项目包含系统集成）
c. 软件工程师
d. 测试工程师
e. 配置管理员
项目计划必须明确规定每个人的技术岗位。
5.3.3 对于需要转包或部分转包的项目的管理，见《委托方控制程序》。
5.3.4项目计划需说明项目的组织管理方法，包括项目内小组如何设置，小组与技术岗位的关系，小组之间的接口关系，项目的内部评审如何组织等。
5.4 项目的资源分配
5.4.1 人员分配
a. 规定每个技术岗位的人员数目和人员；
b. 规定项目不同阶段应投入的不同技术岗位的人员数目。
5.4.2 工作环境要求和用途
a. 说明所需硬件平台要求，包括现有的平台状况，需增加哪些硬件、配置和数量；
b. 说明网络环境要求，包括现有状况，需增加哪些设备和软件，及其数量；
c. 说明软件平台要求，包括现有状况，需增加哪些软件平台和工具，及其数量。
d. 说明以上硬件设备、软件平台、软件工具，网络设施的具体用途。
5.4.3 项目成本估算
详细列出用于人员投入，设备购置，材料消耗，差旅，会议等的各项费用预算。
具体内容和预算方法请参见中心财务部的有关规定。
5.5 项目的进度安排
5.5.1 规划各项任务的时间进度，分配完成任务所需的人员和设备；
5.5.2 用图形的方法绘制任务进度和关系图；
5.6 风险分析和处理
5.6.1分析并说明影响项目达到预期目标的可能的风险。
5.6.2说明对每种风险的解决办法。
5.8 其它相关计划的编写
5.8.1项目负责人应组织项目组内有关人员编写【配置管理计划】和【项目阶段计划】。
a. 配置管理员负责编制【配置管理计划】，具体规定参见《配置管理程序》和《配置管理计划编写规范》。
并报配置部批准。
b. 有关人员编写【项目阶段计划】，并报部门经理批准。
5.9项目计划的审核和批准
5.9.1 【项目计划】由大部经理，部门经理和项目负责人审核，由大部经理批准， 部门经理监督执行，项目负责人实施。
5.10 项目计划的修改
5.10.1 项目计划不应频繁修改。
建议在以下情况发生时，可以修改项目计划。
a. 人员发生重大变化和调整；
b. 必要的设备得不到保证；
c. 资金长久不能到位，又没有其他解决办法；
d. 某个技术难点造成进度的较长延误；
e. 合作方和/或顾客因素造成进度的较长延误。
5.10.2批准后的项目计划的第一版本作为比较基准保存。
5.10.3修改后的项目计划要经再次审核批准，将其作为中期计划保存。
6. 引用文件
《软件配置管理程序》 （T.CX0801-A01）
《配置管理计划编写规范》 （T.ZY0802-A01）
《委托方控制程序》 （T.CX0601-A01）
《项目管理流程》 （T.ZY1502-A01）
7. 质量记录
【项目计划】 （T.JL0401-A01）
【项目中期计划】 （T.JL0402-A01）
二．测试文档
测试计划 序号：
1 概述
a 被测系统的简介
b 本计划的目的和范围
2 测试过程
a 测试的目标-----包括测试的目的，测试的类型，测试的级别
b 测试的指导方针---- 各项测试活动的分工（例如谁负责生成用于测试的可执行代码，谁来负责具体执行各项测试）
升级会员 