中科院-数据库建设技术文档参考规范.doc

项目编号INFO-115-C01文档编号TR-REC-062中国科学院数据应用环境建设与服务数据库建设技术文档参考规范（征求意见稿）中国科学院数据应用环境建设与服务 项目组 2009年6月前 言本文档规范是参考了软件工程文档规范国家标准GB856788，台湾省中央研究院元数据需求规格书规范等相关标准、规范，并结合中国科学院数据应用环境建设与服务项目的实际情况编写而成。本文档规范的目的是为中国科学院数据应用环境建设与服务项目各建库单位在数据库建设过程中编写文档提供参考。所有的文档模板只提供了通用的、可供参考的大纲，不同的建库单位可根据各自不同的需求选择文档模板，也可以对文档模板做必要的修改和调整。但数据库需求说明书和数据库设计说明书是数据库建设必备的文档，原则上要求所有建库单位都应该具备。在每一份文档模板中，用“”标注的元素作为可选元素。本文汇编了数据库需求说明书、数据库元数据需求规格书、数据库设计说明书、数据库软件概要设计说明书、数据库软件详细设计说明书、数据库软件开发卷宗、数据库运行维护记录共7份数据库开发主要文档模板，其依据是从中国科学院数据应用环境建设与服务项目数据库长期发展和管理的角度提出的，并结合了项目建库的实际情况和科学数据库管理要求。目 录科学数据库需求说明书1科学数据库元数据需求规格书11科学数据库设计说明书17科学数据库软件概要设计说明书23科学数据库软件详细设计说明书29科学数据库软件模块开发卷宗35科学数据库更新维护说明书39编号【项目名称】数据库需求说明书【单位名称】【作者姓名】【版本号】【日期】目 录1引言41.1编写目的41.2背景41.3定义41.4参考资料42数据需求说明42.1 数据来源说明42.2 数据约定52.3 数据采集策略和规范52.3.1 数据采集的基本原则52.3.2 数据采集的过程控制52.3.3 数据更新和处理的频度52.3.3 数据输入的要求53元数据需求说明63.1 元素著录结构63.2 需求元素设置63.3 需求元素属性73.4 元素代码表73.5 元数据标准映射表84应用软件需求说明84.1对功能的规定84.2对性能的规定84.2.1精度84.2.2时间特性要求84.2.3灵活性84.3输入输出要求94.4数据管理能力要求94.5故障处理要求94.6其他专门要求95系统运行环境规定95.1设备95.2支持软件95.3接口105.4控制101引言1.1编写目的说明编写这份需求说明书的目的，指出预期的读者。1.2背景1. 说明待建设的数据库及其应用系统的名称2. 说明本数据库系统的学科特点，建设的目的，服务对象，预期成果等。3. 说明支持本数据库系统建设的项目来源4. 说明本数据库系统和其他数据库系统之间的关系1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考资料。1. 本项目的经核准的计划任务书或合同、上级机关批文；2. 属于本项目的其他已发表的文件；3. 本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。2数据需求说明2.1 数据来源说明详细说明本数据库内容的主要来源:1. 如果是从文献中摘录数据，逐一注明文献的名称和出处等基本信息；2. 如果是来自于相关的科研课题，简要说明课题背景信息，包括课题名称，课题支持机构，课题负责人，课题研究的主要内容等；3. 如果是通过镜像、购买、交换或者下载等手段获取的数据，说明出处；4. 实验、观测、统计调查等数据，需说明相关的仪器、设备、过程、方法等基本信息背景；5. 其它数据来源也请根据情况说明数据产生、收集的基本背景。2.2 数据约定说明本数据库对数据要求的制约，也作为数据采集、加工的基本原则和规范，基本内容包括：1. 时间范围约定：约定数据库数据的时间跨度；2. 空间范围约定：约定数据库数据的空间范围；3. 学科范围约定：说明数据所属（或所涉及）的学科范围；4. 数据量：说明计划本数据库将来的数据容量（如多少MB或多少条记录等）；5. 数据精度约定：数值数据约定数据的量纲（度量单位），精度，有效值范围等；图像数据约定数字图像的解析度；在数据是非数字量的情况下，给出每一种合法值的形式和含意；6. 语言约定：约定数据库数据表述的语言；7. 数据类型约定：约定数据库数据的基本类型，如图形、图像、文本、数字等8. 其它约定：根据数据库各自的学科特点及各种特殊要求做相应的其它约定；2.3数据采集策略和规范2.3.1数据采集的基本原则说明为了保证数据质量和数据的完整性，所遵循的数据采集的基本原则和策略。2.3.2数据采集的过程控制详细说明数据从收集、整理、加工到录入、校对以及最后入库的全过程，包括拟采用的方法，设备，工具软件，参加人员等，并且说明每一个过程中将采用哪些数据质量控制的手段等。2.3.3数据更新和处理的频度给出预定的对数据输入、数据更新和处理的频度。2.3.3数据输入的要求将数据输入到系统中一些基本要求，包括：1. 数据输入（指把数据输入处理系统内部）所用的媒体和硬设备。如果只有指定的输入点的输入才是合法的，则必须对此加以说明；2. 数据输入的格式要求；3. 如果输入数据同某一接口软件有关，还应说明该接口软件的来源；4. 其它特殊要求。3元数据需求说明基于数据库的内容进行分析，确定数据库（元）数据的基本元素需求，作为数据库结构设计的主要参考。完整的元数据需求规格书可以代替本部分文档。3.1 元素著录结构本著录结构是经仔细分析确认的数据库数据著录所需元素及元素的先后排序（系统自动产生值或者设定固定值的元素因为不需要人工著录，所以不包括在内），作为开发人员开发数据库数据录入界面之参考，同时也作为数据库分析、设计人员理解数据库需求之参考。元素著录结构表格各项说说明如下: 著录项：需要著录的字段的中文名称 范例：为需要著录的字段录入一笔典型的数据 说明：关于著录项的语义及相关值域的注释和说明著录项范例说明3.2需求元素设置本需求元素设置表主要是把数据库所需要的字段经系统化、结构化之后，列成表格供系统开发人员做数据库结构分析、设计所用，同时也供程序设计人员在撰写程序时参考使用。需求元素设置表之各项说明如下： 元素中文名称：数据库所需字段的中文名称。 元素英文名称：与数据库所需字段的中文名称对应的英文名称。 数据类型：本元素之数据类型包括：int 存放纯数字型态的数据。text、varchar 存放文字型态的数据。其它数据类型 大小：元素所需之空间，以byte为单位。一个英文字符或一个阿拉伯数字需用一个byte表示，而一个汉字字符则需两个byte表示。元素中文名称元素英文名称数据类型长度3.3 需求元素属性需求元素属性表主要是把数据库所需求字段的属性汇集整理，并列成表格供系统分析人员参考使用需求字段属性表各项说明如下： 元素名称：数据库所需著录字段的中文名称。 必填：标示“”者表示为必填字段，著录时需填写该字段之值，不能空白。 多值：标示“”者表示为多值字段，该组字段可重复著录。 属性：标示该字段的属性，包括：唯一表示字段的值在数据库中是唯一存在的。不开放表示该字段只供管理者使用，不对外开放。下拉式菜单表示著录方式为下拉式菜单选择。关联下拉式菜单表示代码内容会随其它关联字段的改变而调整代码内容。系统自动产生表示该字段的值是由系统自动产生，不由著录人员著录。 提供者：记录该条记录是由系统自动产生或由著录人所填入。元素名称必填多值属性提供者3.4 元素代码表说明数据录入时使用到的一些控制词汇和代码等。项目名称代码3.5元数据标准映射表元数据标准映射表是作为该数据库和国际标准的接轨，也是与国际、国内间其它相关数据库作XML数据交换的关键机制。将“需求元素设置表”中的每一个元素映射到选定参考标准对应的元素。4应用软件需求说明详细说明对本数据库系统进行处理的软件的需求，任何一个数据库至少有一个应用系统来实现对数据库管理，并提供基本数据增、删、改和查询检索的功能。复杂的应用包括如基于数据库数据进行数据分析的工具和特殊的应用，这些应用软件的需求说明可以参照软件需求说明格式单独撰写。4.1对功能的规定用列表的方式（例如IPO表即输入、处理、输出表的形式），逐项定量和定性地叙述对软件所提出的功能要求，说明输入什么量、经怎样的处理、得到什么输出，说明软件应支持的终端数和应支持的并行操作的用户数。4.2对性能的规定4.2.1精度说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。4.2.2时间特性要求说明对于该软件的时间特性要求，如对：a 响应时间；b 更新处理时间；c 数据的转换和传送时间；d 解题时间等的要求。4.2.3灵活性说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：a. 操作方式上的变化；b. 运行环境的变化；c. 同其他软件的接口的变化；d. 精度和有效时限的变化；e. 计划的变化或改进。对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。4.3输入输出要求解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。4.4数据管理能力要求说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求做出估算。4.5故障处理要求列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。4.6其他专门要求如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。5系统运行环境规定5.1设备列出运行该系统所需要的硬设备。说明其中的新型设备及其专门功能，包括：a 处理器型号及内存容量；b 外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量；c 输入及输出设备的型号和数量，联机或脱机；d 数据通信设备的型号和数量；e 功能键及其他专用硬件。5.2支持软件列出支持软件,包括要用到的操作系统、编译（或汇编）程序、数据库管理系统、测试支持软件等。5.3接口说明该系统同其他软件之间的接口、数据通信协议等。5.4控制说明控制该系统的运行的方法和控制信号，并说明这些控制信号的来源。40 编号【项目名称】数据库元数据需求规格书【单位名称】【作者姓名】【版本号】【日期】目 录1 前言131.1 编写目的.131.2 建库背景.131.3 建库目标.131.4 参考资料.131.5 主要参与人员.132 元素著录结构.133 需求元素设置.134 需求元素属性.145 代码表.146 元数据标准映射表.157 查询功能需求.158 系统其它功能需求.159 需求规格书确认与其他说明.151前言1.1编写目的说明编写这份需求说明书目的，指出预期的读者。1.2建库背景说明本数据库建设的基本背景，包括学科特点、范围以及建设的意义的等。1.3建库目标详细说明并列举本数据库建设预期达到的主要目标。1.4参考资料列出本份需求规格书主要参考资料，如参考的国际、国内元数据标准，包括标准名称，版本号，发展单位等。1.5主要参与人员列出参加本次需求规格书分析的主要人员名单。2元素著录结构本著录结构是经仔细分析确认的数据库数据著录所需元素及元素的先后排序（系统自动产生值或者设定固定值的元素因为不需要人工著录，所以不包括在内），作为开发人员开发数据库数据录入界面之参考，同时也作为数据库分析、设计人员理解数据库需求之参考。元素著录结构表格各项说说明如下: 著录项：需要著录的字段的中文名称 范例：为需要著录的字段录入一笔典型的数据 说明：关于著录项的语义及相关值域的注释和说明著录项范例说明3需求元素设置需求元素设置表主要是把数据库所需要的字段经系统化、结构化与Metadata标准化之后，列成表格供系统分析人员建数据库时设定字段所用，同时也供程序设计人员在撰写程序时参考使用。需求元素设置表各项说明如下： 元素名称：数据库所需元素之中文名称。 英文名称：元素名称对应之英文名称。 数据类型：元素数据类型包括：int 存放纯数字型态的数据。text、varchar、varchar2等存放文字型态的数据。 大小：字段所需之空间，以byte为单位。一个英文字符或一个阿拉伯数字需用一个byte表示，而一个汉字字符则需两个byte表示。项目名称英文名称数据类型长度4需求元素属性需求元素属性表主要是把数据库所需求字段的属性汇集整理，并列成表格供系统分析人员参考使用需求字段属性表各项说明如下： 元素名称：数据库所需著录字段的中文名称。 必填：标示“”者表示为必填字段，著录时需填写该字段之值，不能空白。 多值：标示“”者表示为多值字段，该组字段可重复著录。 属性：标示该字段的属性，包括：唯一表示字段的值在数据库中是唯一存在的。不开放表示该字段只供管理者使用，不对外开放。下拉式菜单表示著录方式为下拉式菜单选择。关联下拉式菜单表示代码内容会随其它关联字段的改变而调整代码内容。系统自动产生表示该字段的值是由系统自动产生，不由著录人员著录。 提供者：记录该条记录是由系统自动产生或由著录人所填入。元素名称必填多值属性提供者5代码表列出在需求元素属性表中，如果元素的属性一栏为“下拉式菜单”，请详细列出该下拉式菜单的内容。元素名称代码内容6元数据标准映射表元数据标准映射表是作为该数据库和国际标准的接轨，以及与国际、国内间其它数据库作XML数据交换的关键机制。将“需求元素建置表”中的每一个元素映射到选定参考标准对应的元素。7查询功能需求 简单查询：表格中“简单查询”一栏标有“”者可以作为系统简单查询的条件 高级查询：表格中“高级查询”一栏标有“”者作为系统高级查询的条件 简要显示：表格中“简要显示”一栏标有“”者作为“简单查询”和“高级查询”结果的简要显示元素 详细显示：表格中“详细显示”一栏标有“”者作为“简单查询”和“高级查询”结果的详细显示元素元素名称简单查询高级查询简要显示详细显示8系统其它功能需求系统其它功能需求说明。9需求规格书确认与其他说明建库单位负责人确认本需求规格书是否符合其需求，若不符合，请说明原因。编号【项目名称】数据库设计说明书【单位名称】【作者姓名】【版本号】【日期】目 录1引言191.1编写目的191.2背景191.3定义191.4参考资料192外部设计192.1标识符的状态192.2使用它的程序192.3约定202.4专门指导202.5支持软件203结构设计203.1概念结构设计203.2逻辑结构设计203.3物理结构设计204运用设计214.1数据字典设计214.2安全保密设计211引言1.1编写目的说明编写这份数据库设计说明书的目的，指出预期的读者。1.2背景a. 说明待建设的数据库及其应用系统的名称b. 说明本数据库系统的学科特点，建设的目的，服务对象，预期成果等。c. 说明支持本数据库系统建设的项目来源d. 说明本数据库系统和其他数据库系统之间的关系1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考资料。a本项目的经核准的计划任务书或合同、上级机关批文；b属于本项目的其他已发表的文件；c本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。2外部设计2.1标识符的状态联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。如果该数据库属于尚在实验中、尚在测试中或是暂时使用的，则要说明这一特点及其有效时间范围。2.2使用它的程序列出将要使用或访问此数据库的所有应用程序，对于这些应用程序的每一个，给出它的名称和版本号。2.3约定陈述一个程序员或一个系统分析员为了能使用此数据库而需要了解的建立标号、标识的约定。例如：用于标识数据库的不同版本的约定和用于标识库内各个文卷、记录、数据项的命名约定等。2.4专门指导向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导。例如：将被送入数据库的数据的格式和标准、送入数据库的操作规程和步骤，用于产生、修改、更新或使用这些数据文卷的操作指导。如果这些指导的内容篇幅很长，列出可参阅的文件资料的名称和章条。2.5支持软件简单介绍同此数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。说明这些软件的名称、版本号的主要功能特性。列出这些支持软件的技术文件的标题、编号及来源。3结构设计3.1概念结构设计说明本数据库将反映的现实世界中的实体、属性和它们之间的关系等的原始数据形式，包括各数据项、记录的标识符、定义、类型、度量单位和值域，建立本数据库的每一幅用户视图。关系数据库可以给出E-R(Entity实体- Relation关系)图。3.2逻辑结构设计说明把上述原始数据进行分解、合并后重新组织起来的数据库全局逻辑结构，包括所确定的关键字和属性、重新确定的记录结构、所建立的相互关系，形成本数据库的数据库管理员视图。3.3物理结构设计建立系统程序员视图，包括：a数据在内存中的安排，包括对索引区、缓冲区的设计；b所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分；c访问数据的方式方法。4运用设计4.1数据字典设计对数据库设计中涉及到的各种项目，如数据项、记录、系、文卷、模式、子模式等一般要建立起数据字典，以说明它们的标识符、同义名及有关信息。在本节中要说明对此数据字典设计的基本考虑。4.2安全保密设计说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑。编号【项目名称】数据库软件概要设计说明书【单位名称】【作者姓名】【版本号】【日期】目 录1引言251.1编写目的251.2背景251.3定义251.4参考资料252总体设计252.1需求规定252.2运行环境252.3基本设计概念和处理流程252.4结构.252.5功能要求与程序的关系262.6人工处理过程262.7尚未解决的问题263接口设计263.1用户接口263.2外部接口263.3内部接口264运行设计264.1运行模块组合264.2运行控制264.3运行时间275系统数据结构设计275.1逻辑结构设计要点275.2物理结构设计要点275.3数据结构与程序的关系276系统出错处理设计276.1出错信息276.2补救措施276.3系统维护设计281引言1.1编写目的说明编写这份概要设计说明书的目的，指出预期的读者。1.2背景说明：a待开发软件系统的名称；b列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考文件，如：a. 本项目的经核准的计划任务书或合同，上级机关的批文；b. 属于本项目的其他已发表文件；c. 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2总体设计2.1需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见软件需求说明书。2.2运行环境简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见软件需求说明书。2.3基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。2.4结构用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系2.5功能要求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：2.6人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。2.7尚未解决的问题说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。3接口设计3.1用户接口说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。3.2外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。3.3内部接口说明本系统之内的各个系统元素之间的接口的安排。4运行设计 4.1运行模块组合 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。4.2运行控制 说明每一种外界的运行控制的方式方法和操作步骤。4.3运行时间说明每种运行模块组合将占用各种资源的时间。5系统数据结构设计 5.1逻辑结构设计要点 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。 5.2物理结构设计要点给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。 5.3数据结构与程序的关系 说明各个数据结构与访问这些数据结构的形式:6系统出错处理设计6.1出错信息 用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。6.2补救措施说明故障出现后可能采取的变通措施，包括：a) 后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；b) 降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；c) 恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。6.3系统维护设计说明为了系统维护的方便而在程序内部设计中做出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。编号【项目名称】数据库软件详细设计说明书【单位名称】【作者姓名】【版本号】【日期】目 录1引言311.1编写目的311.2背景311.3定义311.4参考资料312程序系统的结构313程序1（标识符）设计说明313.1程序描述313.2功能313.3性能323.4输人项323.5输出项323.6算法323.7流程逻辑323.8接口323.9存储分配323.10注释设计.323.11限制条件.323.12测试计划.323.13尚未解决的问题.324程序2（标识符）设计说明331引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。1.2背景说明：a) 待开发软件系统的名称；b) 本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。1.3定义列出本文件中用到专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考资料，如： a) 本项目的经核准的计划任务书或合同、上级机关的批文；b) 属于本项目的其他已发表的文件；c) 本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。2程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。3程序1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。3.1程序描述给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且还要说明本程序的特点，如：是常驻内存还是非常驻？是否子程序？有无覆盖要求？是顺序处理还是并发处理等。3.2功能 说明该程序应具有的功能，可采IPO图（即输入处理输出图）的形式。3.3性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。3.4输人项给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。3.5输出项给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、 数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。3.6算法 详细说明本程序所选用的算法，具体的计算公式和计算步骤。3.7流程逻辑 用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。3.8接口用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下