软件项目详细设计说明书样本.doc

中国广东核电集团
CHINA GUANGDONG NUCLEAR POWER GROUP
记 录 文 件
项目编号
项目名称
CGN-IT-C3-A01-01
软件项目章程
版本
编写
审核
审定
批准
生效时间
A/0

注: 如无受控文件标识( 蓝色印章) 则为非有效版本, 以受控文件规定为准。
此文件属中国广东核电集团有限公司所有, 未经许可, 不得以任何方式外传。

修改记录页

NO
修改日期
修改摘要( 涉及页码/条款/内容)
版本
修改原因

【模板使用必读: 模板内容和页眉中【】包含内容为指导性的待替换文字, 请在使用中替换为具体内容, 或删除。文件提交时不得再含有这些内容。】
目 录

1 引言 4
1.1 编写目的 4
1.2 背景 4
1.3 术语与缩写解释 4
1.4 参考资料 4
2 模块命名规则 4
3 程序系统的组织结构 5
3.1 子系统划分 5
3.2 模块划分 5
3.3 程序与功能需求、 系统模块间的关系 5
4 程序1( 标识符) 设计说明 5
4.1 程序描述 5
4.2 功能 6
4.3 性能 6
4.4 输人项 6
4.5 输出项 6
4.6 算法 6
4.7 流程逻辑 6
4.8 接口 6
4.9 存储分配 7
4.10 注释设计 7
4.11 限制条件 7
4.12 尚未解决的问题 7
5 程序2( 标识符) 设计说明 7

1 引言
1.1 编写目的
【给出项目详细设计说明书的编写目的, 同时指明读者对象。】
1.2 背景
【说明:
a．待开发软件系统的名称;
b.本项目的任务提出者、 开发者、 用户和运行该程序系统的计算中心。】
1.3 术语与缩写解释
【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组。】

缩写、 术语
解 释
PMO
项目管理办公室, Project Management Office
PP
项目策划( 规划) , Project Planning

…

1.4 参考资料
【提示: 可包括: ( 1) 本项目经核准的计划任务书、 需求规格说明书、 合同、 项目设计概要说明书或上级机关的批文; ( 2) 本文档所引用的资料、 规范等, 列出这些资料的作者、 标题、 编号、 发表日期、 出版单位或资料来源。】
2 模块命名规则
【确定本软件的模块命名规则, 例如类、 函数、 变量等, 确保设计文档的风格保持一致。能够从机构的编码规范中摘取或引用。】

3 程序系统的组织结构
【用一系列图表列出本程序系统内的每个程序( 包括每个模块和子程序) 的名称、 标识符和它们之间的层次结构关系。】
3.1 子系统划分
3.2 模块划分
3.3 程序与功能需求、 系统模块间的关系
程序标识
需求标识
模块标识
程序1( 标识符)

程序2( 标识符)

……

程序n( 标识符)

4 程序1( 标识符) 设计说明
【从本章开始, 逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块, 特别是层次比较低的模块或子程序, 其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同, 在这种情况下, 只要简单地说明这一点即可。】
4.1 程序描述
【给出对该程序的简要描述, 主要说明安排设计本程序的目的意义, 说明本程序的特点。】
4.2 功能
【说明该程序应具有的功能, 可采用IPO图( 即输入一处理一输出图) 的形式。】
4.3 性能
【说明对该程序的全部性能要求, 包括对精度、 灵活性和时间特性的要求。】
4.4 输人项
【给出对每一个输入项的特性, 包括名称、 标识、 数据的类型和格式、 数据值的有效范围、 输入的方式。数量和频度、 输入媒体、 输入数据的来源和安全保密条件等等。】
4.5 输入界面
【给出输入项的界面图】

4.6 输出项
【给出对每一个输出项的特性, 包括名称、 标识、 数据的类型和格式, 数据值的有效范围, 输出的形式、 数量和频度, 输出媒体、 对输出图形及符号的说明、 安全保密条件等等。】
4.7 输出界面
【给出输出项的界面图】

4.8 算法
【详细说明本程序所选用的算法, 写出具体的计算公式和计算步骤。】
4.9 流程逻辑
【用图表( 例如流程图、 判定表等) 辅以必要的说明来表示本程序的逻辑流程。如果涉及到界面, 把界面要画出来。】
4.10 接口
【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、 子程序, 说明参数赋值和调用方式, 说明与本程序相直接关联的数据结构( 数据库、 数据文卷) 。】
4.11 存储分配
【根据需要, 说明本程序的存储分配。】
4.12 注释设计
【说明准备在本程序中安排的注释, 如:
a． 加在模块首部的注释;
b． 加在各分枝点处的注释;
c． 对各变量的功能、 范围、 缺省条件等所加的注释;
d． 对使用的逻辑所加的注释等等。】
4.13 限制条件
【说明本程序运行中所受到的限制条件。】
4.14 尚未解决的问题
【说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。当确认在设计中无遗留问题时, 此项能够去掉。】
5 程序2( 标识符) 设计说明
【用类似4的方式, 说明第2个程序乃至第N个程序的设计考虑。】
......