软件数据库设计说明模板.docx

1 .范围标识本条应描述本文档所适用系统和软件的完整标识，适用时，包括其标识号、名称、 缩略名、版本号和发布号。1.1 数据库概述本条应简要描述本文档所适用数据库的用途。它应描述该数据库的一般特性；概 述其开发、使用和维护的历史；标识工程的投资方、需方、用途、开发方和保障机构； 标识当前和计划的运行现场；列出其他有关文档。1.2 文档概述本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。2 .引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通 过正常采购活动得到的文档的来源。3 .数据库级设计决策本章应视需要分条给出数据库级设计决策，即数据库的行为设计决策（忽略其内 部实现，从用户角度出发描述数据库将怎样运转以满足需求）以及其他影响数据库进 一步设计的决策。如果所有这些决策在系统需求或CSCI需求中均是明确的，本章应如 实陈述。对应于指定为关键性需求（例如对平安性或保密性需求）的设计决策，应在 专门的章条中加以表达。如果一个设计决策依赖于系统状态或方式，应指明这一依赖 性。如果设计决策的局部或全部在定制的或商用的数据库管理系统（DBMS）中进行了 描述，本章可以直接引用。本章应给出或引用理解设计所需的设计约定。数据库级设 计决策的例子如下：a）关于数据库将接收的查询或其他输入以及它将产生的输出（显示、报表、消息、 响应等），包括与其他系统、HWCI、CSCI及用户的接口的设计决策（本文档的 条指出这项说明应考虑的主题）。如果这一信息的全部或局部在接口设计 说明（IDD）中给出，那么可以直接引用。b）有关响应每个输入或查询时数据库行为的设计决策,包括数据库将执行什么动 作，响应时间和其他性能特性，所选择的方程式/算法/规那么，处理和对不允许 的输入的处理。c）有关数据库/数据文件如何呈现给用户的设计决策（本文档的4.X条标识了这项说明应考虑的主题）。d）有关所使用的数据库管理系统（包括名称、版本/发布版）以及为适应需求的 变更而引人到数据库内部的灵活性类型的设计决策。e）有关数据库应提供的可用性、平安性、保密性和操作连续性的等级和类型的设 计决策。f）有关数据库的分布（例如客户/服务器）、主数据库文件的更新和维护的设计决 策，包括维护一致性、建立同步/重建同步和维持同步、强制完整性和业务规 那么。g）有关备份与恢复的设计决策，包括数据和处理的分布策略，备份和恢复过程中 允许的动作，以及对新技术或非标准技术（如视频和声音等）的特殊考虑。h）关于重新打包、排序、索引、同步以及一致性的设计决策，包括自动磁盘管理 和自动空间回收、优化策略、存储与空间大小以及数据库的规模与继承数据捕 获等方面的考虑。4 .数据库详细设计注：本文档用“数据元素集合” 一词来代表在一指定的设计级别（例如概念设计、内部设计、逻辑设计、物理 设计）上具有结构（数据元素的编号/次序/分组）的任何实体、关系、模式、字段、表、数组等，用“数据元素” 一词来代表在该级别上不具有结构的任何关系、属性、字段、单元（cell）,数据元素等。5 .X （数据库设计级别的名称）本条应标识数据库设计级别，并用所选择的设计方法的术语描述数据库的数据元 素和数据元素集合。（假设适用）这些信息应包括如下内容，它们可按任何适合于所提供 信息的顺序提供：a）数据库设计中各个数据元素的特征，例如：1）名称/标识符：a.工程唯一的标识符；b.非技术（自然语言）名称；c.数据元素名称；d.技术名称（如在数据库中字段名）；e.缩略名或同义名。2）数据类型（字母、数字、整数等）。3）大小和格式（如：字符串的长度和标点符号）。4）计量单位（如：m等）。5）可能值的范围或枚举（如：0-99）o6）准确性（正确程度）和精度（有效数位数）。7）优先级别、定时、频率、容量、排序以及其他约束条件（例如数据元素是否 可以被更新、业务规那么是否适用）。8）保密性约束。9）来源（建立/发送的实体）和接受者（使用/接收的实体）。b）数据库设计中的数据元素组合体（记录、消息、文件、数组、显示、报表等） 的特征，例如：1）名称/标识符：a.工程唯一的标识符；b.非技术（自然语言）名称；c.技术名称（如在代码或数据库中的记录名或数据结构名）；d.缩略名或同义名。2）数据元素组合体中的数据元素及其结构（编号、顺序和分组）；3）介质（例如磁盘）以及在介质上数据元素/数据元素组合体的机构。4）显示和其他输出的视听特征（例如颜色、布局、字体、图标和其他显示元 素、峰鸣音和亮度）。5）数据元素组合体之间的关系，如分类/存取特征。6）优先级、定时、频率、容量、序列及其他约束，例如数据元素组合体是否 可以被更新、业务规那么是否适用。7）保密性约束。8）来源（建立/发送的实体）和接受体（使用/接收的实体）。6 .用于数据库访问或操作的软件单元的详细设计5.X （软件单元的工程唯一的标识符，或者一组软件单元的标志符）本条应该通过工程唯一的标识符来标识软件单元，并且对该单元进行说明。（假设适 用）这一说明应包括以下信息。本条也可以指定一组软件单元，然后再分条对它们分 别进行标识和说明。包含其他软件单元的软件单元，可以引用那些软件单元的说明， 而无需在此重复。a）（假设有）单元设计决策，例如所使用的算法等，如果此前尚未选定。b）该软件单元设计中的任何约束、限定或非常规特性。c）所采用的不同于为该CSCI所指定语言的编程语言及使用它的理由。d）如果该软件单元包含过程性命令或是由其组成（例如数据库管理系统（DBMS） 中用于定义表盒报表的菜单项选择择，用于数据库访问和操纵的在线DBMS查询,对用于代码自动生成的图形用户接口（GUI）构造器的输入，给操作系统的命 令或Shell脚本），应列出这些过程性命令，并引用解释它们的用户手册或其他 文档。e）如果该软件单元包含、接收或输出数据，（假设适用）应对它的输入、输出以及 其他数据元素和数据元素集合进行说明。该软件单元的局部数据应该单独描述, 不应该和输入或输出数据混在一起。接口特性可以在此提供，也可以引用接口 设计说明（IDD）。如果一指定的接口实体本DBDD没有覆盖（例如，一个外部 系统），但是其接口特性在本DBDD描述软件单元时需要提到，那么这些特性应 作为假设进行描述、或以“当未提及实体这样做时，软件单元将.”的形 式进行描述。本条可引用其他文档（例如数字字典、协议标准、用户接口标准） 代替本条的信息描述。（假设适用）设计说明应包括如下内容，以适合于所提供 信息的任何顺序给出，并应从接口实体角度指出这些特性之间的区别（例如对 数据元素的大小、频率或其他特性的不同期望值）：1）接口的工程唯一的标识符。2）（假设适用）用名称、编号、修订以及文档引用来标识接口实体（软件单元、 配置项、用户等）。3）接口实体分配给接口的优先级。4）要实现的接口类型（例如实时数据传输、数据的存储和检索等）。5）接口实体将提供、存储、发送、访问、接收的各个数据元素的特征。本文 档中的条标识出了在本说明中需要包含的内容。6）接口实体将提供、存储、发送、访问、接收的数据元素组合体（记录、消 息、文件、数组、显示、报表等）的特征。本文档中的4Xb条，标识了本 说明中需要包含的内容。7）接口实体将用于该接口的通信方法的特征，例如：a.工程唯一的标识符；b.通信链接/带宽/频率/介质和他们的特性；c.消息格式；d.流控制（如：序列编号和缓冲区分配）；e.数据传输率、周期的或非周期的、以及传送间隔；f.路由、寻址、命名约定；g.传输服务，包括优先级与等级；h.平安性/保密性考虑，如：加密、用户鉴别、间隔和审核。8）接口实体将用于该接口的协议的特征，如：a.工程唯一的标识符；b.协议的优先级别/层次；c.打包，包括分段与重组、路由及寻址；d.合法性检查、错误控制和恢复过程；e.同步，包括连接的建立、保持和终止；f.状态、标识及任何其他报告特征。9）其他特征，例如接口实体的物理兼容性（尺寸、公差、负荷、电压和接插 件的兼容性等）。f）如果该软件单元包含逻辑，给出其要使用的逻辑，（假设适用）应包括：1）该软件单元执行启动时，其内部起作用的条件。2）该软件单元将控制传递给其他软件单元的条件。3）对每个输入的响应以及响应时间，包括数据转换、重命名以及数据传输操 作。4）软件单元运行期间的操作顺序和动态控制序列，包括：a.顺序控制的方法；b.该方法的逻辑和输入条件，例如时序变化、优先级分配等；c.进出内存的数据传输；d.对离散输入信号的感知，以及该软件单元内中断操作之间的时序关系。5）异常和错误处理。6 .需求可追踪性本章应描述：a）从本DBDD所涵盖的每个数据库或其他软件单元，到它所处理的系统需求或 CSCI需求的可追踪性；b）从已分配给本DBDD所涵盖的数据库或其他软件单元的每个系统或CSCI需求, 到处理该需求的数据库或其他软件单元的可追踪性。7 .注释本章应包括有助于了解文档的所有信息（例如：背景、术语、缩略语或公式）。