发信人: bllsbgw(SPARK)
整理人: soaringbird(2002-03-05 15:20:58), 站内信件
|
附录F
详细设计说明书的编写提示
（参考件）
F·1引言
F·1·1编写目的
说明编写这份详细设计说明书的目的，指出预期的读者。
F·1·2背景
说明：
a．待开发软件系统的名称；
b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。
F·1·3定义
列出本文件中用到专门术语的定义和外文首字母组词的原词组。
F·1·4参考资料
列出有关的参考资料，如：
a．本项目的经核准的计划任务书或合同、上级机关的批文；
b．属于本项目的其他已发表的文件；
c.本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。
F·2程序系统的结构
用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。
F·3程序1（标识符）设计说明
从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
F·3·1程序描述
给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发 处理卜…··等）。
F.3.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。
F·3.3性能
说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。
F·3·4输人项
给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
F. 3· 5输出项
给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、 数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。
F．3．6算法
详细说明本程序所选用的算法，具体的计算公式和计算步骤。
F．3．7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
F．3.8接口
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。
F．3.9存储分配
根据需要，说明本程序的存储分配。
F．3．10注释设计
说明准备在本程序中安排的注释，如：
a. 加在模块首部的注释；
b．加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释；
d．对使用的逻辑所加的注释等等。
F．3.11限制条件
说明本程序运行中所受到的限制条件。
F．3．12测试计划
说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
F．3.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
F．4程序2（标识符）设计说明
用类似F．3的方式，说明第2个程序乃至第N个程序的设计考虑。
...
附录G
数据库设计说明书的编写提示
（参考件）
G.1引言
G.1·1编写目的
说明编写这份数据库设计说明书的目的，指出预期的读者。
G.1.2背景
说明：
a．说明待开发的数据库的名称和使用此数据库的软件系统的名称；
b·列出该软件系统开发项目的任务提出者、用户以及将安装该软件和这个数据库的计算站（中心)。
G·1．3定义
列出本文件中用到的专门术语的定义、外文首字母组词的原词组。
G．1．4参考资料
列出有关的参考资料：
a．本项目的经核准的计划任务书或合同、上级机关批文；
b．属于本项目的其他已发表的文件；
c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。
G·2外部设计
G．2．1标识符和状态
联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。如果该数据库属于尚在实验中、尚在测试中或是暂时使用的，则要说明这一特点及其有效时间范围。
G·2·2使用它的程序
列出将要使用或访问此数据库的所有应用程序，对于这些应用程序的每一个，给出它的名称和版本号。
G·2．3约定
陈述一个程序员或一个系统分析员为了能使用此数据库而需要了解的建立标号、标识的约定，例如 用于标识数据库的不同版本的约定和用于标识库内各个文卷、、记录、数据项的命名约定等。
G·2·4专门指导
向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导，例如将被送入数据 库的数据的格式和标准、送入数据库的操作规程和步骤，用于产生、修改、更新或使用这些数据文卷的操 作指导。 如果这些指导的内容篇幅很长，列出可参阅的文件资料的名称和章条。
G．2．5支持软件
简单介绍同此数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修 改、更新数据库的程序等。说明这些软件的名称、版本号和主要功能特性，如所用数据模型的类型、允许 的数据容量等。列出这些支持软件的技术文件的标题、编号及来源。
G·3结构设计
G·3·1概念结构设计
说明本数据库将反映的现实世界中的实体、属性和它们之间的关系等的原始数据形式，包括各数据项、记录、系、文卷的标识符、定义、类型、度量单位和值域，建立本数据库的每一幅用户视图。
G·3.2逻辑结构设计
说明把上述原始数据进行分解、合并后重新组织起来的数据库全局逻辑结构，包括所确定的关键字和属性、重新确定的记录结构和文卷结构、所建立的各个文卷之间的相互关系，形成本数据库的数据库管理员视图。
G·3·3物理结构设计
建立系统程序员视图，包括：
a．数据在内存中的安排，包括对索引区、缓冲区的设计；
b．所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分；
c．访问数据的方式方法。
G·4运用设计
G·4·1数据字典设计
对数据库设计中涉及到的各种项目，如数据项、记录、系、文卷、模式、子模式等一般要建立起数据字典，以说明它们的标识符、同义名及有关信息。在本节中要说明对此数据字典设计的基本考虑。
G·4．2安全保密设计
说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑。
附录H
用户手册的编写提示
（参考件）
H·1引言
H·1·1编写目的
说明编写这份用户手册的目的，指出预期的读者。
H.1·2背景
说明：
a.这份用户手册所描述的软件系统的名称；
b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的计算中心。
H·1·3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
H·1·4参考资料
列出有用的参考资料，如：
a.项目的经核准的计划任务书或合同、上级机关的批文；
b．属于本项目的其他已发表文件；
c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够取得这些文件资料的来源。
H．2用途
H·2．1功能
结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。
H.2.2性能
H·2·2.1精度
逐项说明对各项输入数据的精度要求和本软件输出数据达到的精度，包括传输中的精度要求。
H·2.2·2时间特性
定量地说明本软件的时间特性，如响应时间，更新处理时间，数据传输、转换时间，计算时间等。
H.2.2·3灵活性
说明本软件所具有的灵活性，即当用户需求（如对操作方式、运行环境、结果精度、时间特性等的要求）有某些变化时，本软件的适应能力。
H． 2． 3 安 全保密
说明本软件在安全、保密方面的设计考虑和实际达到的能力。
H.3运行环境
H·3.1 硬设备
列出为运行本软件所要求的硬设备的最小配置，如：
a·处理机的型号、内存容量;
b．所要求的外存储器、媒体、记录格式、设备的型号和台数、联机／脱机；
c. I／O设备（联机／脱机？）；
d．数据传输设备和转换设备的型号、台数。
H．3．2支持软件
说明为运行本软件所需要的支持软件，如：
a．操作系统的名称、版本号；
b．程序语言的编译／汇编系统的名称和版本号；
c．数据库管理系统的名称和版本号；
d．其他支持软件。
H．3.3数据结构
列出为支持本软件的运行所需要的数据库或数据文卷。
H．4使用过程
在本章，首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。
11． 4． 1安装与初始化
一步一步地说明为使用本软件而需进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。
H·4．2输入
规定输入数据和参量的准备要求。
H．4．2．1输入数据的现实背景
说明输入数据的现实背景，主要是
a.情况——例如人员变动、库存‘缺货；
b．情况出现的频度——例如是周期性的、随机的、一项操作状态的函数．
c．情况来源—一例如人事部门、仓库管理部门；
d．输入媒体———例如键盘、穿孔卡片、磁带；
e．限制——出于安全、保密考虑而对访问这些输入数据所加的限制；
f．质量管理——例如对输入数据合理性的检验以及当输入数据有错误时应采取的措施，如建立出错情况的记录等；
g．支配——例如如何确定输入数据是保留还是废弃，是否要分配给其他的接受者等。
H．4．2．2输入格式
说明对初始输入数据和参量的格式要求，包括语法规则和有关约定，如：
a．长度—一例如字符数／行，字符数／项；
b．格式基准——例如以左面的边沿为基准；
c．标号——例如标记或标识符；
d．顺序——例如各个数据项的次序及位置；
e·标点——例如用来表示行、数据组等的开始或结束而使用的空格、斜线、星号、字符组等。
f．词汇表——给出允许使用的字符组合的列表，禁止使用＊的字符组合的列表等；
g．省略和重复——给出用来表示输人元素可省略或重复的表示方式；
h．控制——给出用来表示输入开始或结束的控制信息。
H·4·2．3输入举例
为每个完整的输入形式提供样本，包括：
a．控制或首部——例如用来表示输入的种类和类型的信息，标识符输入日期，正文起点和对所用编码的规定；
b．主体——输入数据的主体，包括数据文卷的输入表述部分；
c．尾部——用来表示输入结束的控制信息，累计字符总数等；
d．省略——指出哪些输入数据是可省略的；
e．重复——指出哪些输入数据是重复的。
H．4．3输出 对每项输出作出说明.
H·4·3·1输出数据的现实背景，
说明输出数据的现实背景，主要是：
a．使用——这些输出数据是给谁的，用来干什么；
b·使用频度——例如每周的、定期的或备查阅的；
c．媒体——打印、CRI显示、磁带、卡片、磁盘，
d．质量管理—一例如关于合理性检验、出错纠正的规定；
e．支配——例如如何确定输出数据是保留还是废弃，是否要分配给其他接受者等。
H·4·2.2输出格式
给出对每一类输出信息的解释，主要是：
a．首部——如输出数据的标识符，输出日期和输出编号；
b．主体——输出信息的主体，包括分栏标题；
c．尾部——包括累计总数，结束标记。
H·4·33输出举例
为每种输出类型提供例子。对例子中的每一项，说明：
a．定义——每项输出信息的意义和用途；
b．来源——是从特定的输入中抽出、从数据库文卷中取出、或从软件的计算过程中得到；
c．特性——输出的值域、计量单位、在什么情况下可缺省等。
H·4·4文卷查询
这一条的编写针对具有查询能力的软件，内容包括：同数据库查询有关的初始化、准备、及处理所需 要的详细规定，说明查询的能力、方式，所使用的命令和所要求的控制规定。
H·4·5出错处理和恢复
列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢 复的能力，用户必须遵循的处理过程。
H·4·6终端操作
当软件是在多终端系统上工作时，应编写本条，以说明终端的配置安排、连接步释、数据和参数输入 步骤以及控制规定．说明通过终端操作进行查询、检索、修改数据文卷的能力、语言、过程以及辅助性程 序等。
附录I
操作手册的编写提示
（参考件）
I．I引言
I．I．I编写目的
说明编写这份操作手册的目的，指出预期的读者。
I．I．2前景
说明：
a．这份操作手册所描述的软件系统的名称；
b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装该软件的计算中心。
I．I．3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
I．I．4参考资料
列出有用的参考资料，如：
a．本项目的经核准的计划任务书或合同、上级机关的批文；
b·属于本项目的其他已发表的文件；
c．本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出 版单位，说明能够得到这些文件资料的来源。
I．2软件征述
I．2．1软件的结构
结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。
I．2．2程序表
列出本系统内每个程序的标识符、编号和助记名。
I．2．3文卷表
列出将由本系统引用、建立或更新的每个永久性文卷，说明它们各自的标识符、编号、助记名、存储 媒体和存储要求。
I．3 安装与初始化
一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始 化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。如果有的 话，还应说明安装过程中所需用到的专用软件。
I．4运行说明
所谓一个运行是指提供一个启动控制信息后，直到计算机系统等待另一个启动控制信息时为止的 计算机系统执行的全部过程。
I．4．1运行表
列出每种可能的运行，摘要说明每个运行的目的，指出每个运行各自所执行的程序。
I．4．2运行步骤
说明从一个运行转向另一个运行以完成整个系统运行的步骤。
I． 4． 3运行1（标识符）说明
把运行1的有关信息，以对操作人员为最方便最有用的形式加以说明。
I·4·3·1运行控制
列出为本运行所需要”的运行流向控制的说明。
I·4·3.2操作信息
给出为操作中心的操作人员和管理人员所需要的信息，如：
a. 运行目的；
b．操作要求；
c. 启动方法 如应请启动（由所遇到的请求信息启动）、预定时间启动、…，··等；
d．预计的运行时间和解题时间； 操作命令；
f．与运行有联系的其他事项。
I．4．3.3输入一输出文卷
提供被本运行建立、更新或访问的数据文卷的有关信息，如：
a. 文卷的标识符或标号；
b·记录媒体；
c.存留的目录表；
d．文卷的支配如确定保留或废弃的准则、是否要分配给其他接受者、占用硬设备的优先级以及 保密控制等有关规定。
I．4．3．4输出文段
提供本软件输出的每一一个用于提示、说明、或应答的文段（包括“菜单”）的有关信息，如：
a. 文段的标识符；
b．输出媒体（屏幕显示、打印、……）；
c. 文字容量；
d．分发对象；
e. 保密要求。
I．4．3．5输出文段的复制
对由计算机产生，而后需用其他方法复制的那些文段提供有关信息，如：
a. 文段的标识符；
b．复制的技术手段；
c. 纸张或其他媒体的规格；
d．装订要求；
e. 分发对象；
f．复制份数。
I．4．3.6恢复过程
说明本运行故障后的恢复过程。
I．4．4运行2（标识符）说明
用与本手册1．4．3条相类似的方式介绍另一个运行的有关信息。
I．5非常规过程
提供有关应急操作或非常规操作的必要信息，如出错处理操作、向后备系统的切换操作以及其他必 须向程序维护人员交待的事项和步骤。
I．6远程操作
如果本软件能够通过远程终端控制运行，则在本章说明通过远程终端运行本软件的操作过程。
附录J
模块开发卷宗的编写提示
（参考件）
J．1标题
软件系统名称和标识符
模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号（说明本卷宗在整个卷宗中的序号）
编排日期（说明整个卷宗最近的一次编排日期）
J．2模块开发情况表
J．3功能说明
扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。
J．4设计说明
说明本模块（或本组模块）的设计考虑，包括：
a．在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；
b．在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；
c．在编制目前已通过全部测试的源代码时实际使用的设计考虑。
J．5原代码清单
要给出所产生的本模块（或本组模块）的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。
J．6测试说明
说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
J．7复审的结论
把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。
|
|