发信人: newskysoft()
整理人: leeyg(2001-06-05 21:41:22), 站内信件
|
详细设计说明书的编写提示
（参考件）
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安全保密设计
说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑。
|
|