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

中华人民共和国广东核电集团

CHINAGUANGDONGNUCLEARPOWERGROUP

记录文件

项目编号

项目名称

CGN-IT-C3-A01-01

软件项目章程

版本

编写

审核

审定

批准

生效时间

A/0

注：如无受控文献标记（蓝色印章）则为非有效版本，以受控文献规定为准。

此文献属中华人民共和国广东核电集团有限公司所有，未经允许，不得以任何方式外传。

修改记录页

NO

修改日期

修改摘要（涉及页码/条款/内容）

版本

修改因素

【模板使用必读：模板内容和页眉中【】包括内容为指引性待替代文字，请在使用中替代为详细内容，或删除。文献提交时不得再具有这些内容。】

目录

TOC\o1-3\h\z1 引言 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

引言

编写目

【给出项目详细设计阐明书编写目，同步指明读者对象。】

背景

【阐明：

a．待开发软件系统名称；

b.本项目任务提出者、开发者、顾客和运营该程序系记录算中心。】

术语与缩写解释

【列出本文献中用到专门术语定义和外文首字母缩写原词组。】

缩写、术语

解释

PMO

项目管理办公室，ProjectManagementOffice

PP

项目策划（规划），ProjectPlanning

…

参照资料

【提示：可涉及：（1）本项目经核准筹划任务书、需求规格阐明书、合同、项目设计概要阐明书或上级机关批文；（2）本文档所引用资料、规范等，列出这些资料作者、标题、编号、刊登日期、出版单位或资料来源。】

模块命名规则

【拟定本软件模块命名规则，例如类、函数、变量等，保证设计文档风格保持一致。可以从机构编码规范中摘取或引用。】

程序系统组织构造

【用一系列图表列出本程序系统内每个程序（涉及每个模块和子程序）名称、标记符和它们之间层次构造关系。】

子系统划分

模块划分

程序与功能需求、系统模块间关系

程序标记

需求标记

模块标记

程序1（标记符）

程序2（标记符）

……

程序n（标记符）

程序1（标记符）设计阐明

【从本章开始，逐个地给出各个层次中每个程序设计考虑。如下给出提纲是针对普通状况。对于一种详细模块，特别是层次比较低模块或子程序，其诸多条目内容往往与它所从属上一层模块相应条目内容相似，在这种状况下，只要简朴地阐明这一点即可。】

程序描述

【给出对该程序简要描述，重要阐明安排设计本程序目意义，阐明本程序特点。】

功能

【阐明该程序应具备功能，可采用IPO图（即输入一解决一输出图）形式。】

性能

【阐明对该程序所有性能规定，涉及对精度、灵活性和时间特性规定。】

输人项

【给出对每一种输入项特性，涉及名称、标记、数据类型和格式、数据值有效范畴、输入方式。数量和频度、输入媒体、输入数据来源和安全必威体育官网网址条件等等。】

输入界面

【给出输入项界面图】

输出项

【给出对每一种输出项特性，涉及名称、标记、数据类型和格式，数据值有效范畴，输出形式、数量和频度，输出媒体、对输出图形及符号阐明、安全必威体育官网网址条件等等。】

输出界面

【给出输出项界面图】

算法

【详细阐明本程序所选用算法，写出详细计算公式和计算环节。】

流程逻辑

【用图表（例如流程图、鉴定表等）辅以必要阐明来表达本程序逻辑流程。如果涉及到界面，把界面要画出来。】

接口

【用图形式阐明本程序所从属上一层模块及从属于本程序下一层模块、子程序，阐明参数赋值和调用方式，阐明与本程序相直接关联数据构造（数据库、数据文卷）。】

存储分派

【依照需要，阐明本程序存储分派。】

注释设计

【阐明准备在本程序中安排注释，如：

加在模块首部注释；

加在各分枝点处注释；

对各变量功能、范畴、缺省条件等所加注释；

对使用逻辑所加注释等等。】

限制条件

【阐明本程序运营中所受到限制条件。】

尚未解决问题

【阐明在本程序设计中尚未解决而设计者以为在软件完毕之前应解决问题。当确认在设计中无遗留问题时，此项可以去掉。】

程序2（标记符）设计阐明

【用类似4方式，阐明第2个程序乃至第N