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

项目编号 INFO-115-C01 文档编号 TR-REC-062 中国科学院数据应用环境建设与服务 数据库建设技术文档 参考规范 （征求意见稿） 中国科学院数据应用环境建设与服务 项目组 2009年6月 前 言 本文档规范是参考了软件工程文档规范国家标准GB8567—88，台湾省中央研究院元数据需求规格书规范等相关标准、规范，并结合中国科学院数据应用环境建设与服务项目的实际情况编写而成。本文档规范的目的是为中国科学院数据应用环境建设与服务项目各建库单位在数据库建设过程中编写文档提供参考。 所有的文档模板只提供了通用的、可供参考的大纲，不同的建库单位可根据各自不同的需求选择文档模板，也可以对文档模板做必要的修改和调整。但《数据库需求说明书》和《数据库设计说明书》是数据库建设必备的文档，原则上要求所有建库单位都应该具备。在每一份文档模板中，用“[]”标注的元素作为可选元素。 本文汇编了《数据库需求说明书》、《数据库元数据需求规格书》、《数据库设计说明书》、《数据库软件概要设计说明书》、《数据库软件详细设计说明书》、《数据库软件开发卷宗》、《数据库运行维护记录》共7份数据库开发主要文档模板，其依据是从中国科学院数据应用环境建设与服务项目数据库长期发展和管理的角度提出的，并结合了项目建库的实际情况和科学数据库管理要求。  目 录 科学数据库需求说明书 1 科学数据库元数据需求规格书 11 科学数据库设计说明书 17 科学数据库软件概要设计说明书 23 科学数据库软件详细设计说明书 29 科学数据库软件模块开发卷宗 35 科学数据库更新维护说明书 39  [编号] 目 录 1 引言 4 1.1 [编写目的] 4 1.2 背景 4 1.3 [定义] 4 1.4 [参考资料] 4 2 数据需求说明 4 2.1 数据来源说明 4 2.2 数据约定 5 2.3 数据采集策略和规范 5 2.3.1 数据采集的基本原则 5 2.3.2 数据采集的过程控制 5 2.3.3 数据更新和处理的频度 5 2.3.3 [数据输入的要求] 5 3 [元数据需求说明] 6 3.1 [元素著录结构] 6 3.2 需求元素设置 6 3.3 需求元素属性 7 3.4 [元素代码表] 7 3.5 [元数据标准映射表] 8 4 [应用软件需求说明] 8 4.1 对功能的规定 8 4.2 [对性能的规定] 8 4.2.1 精度 8 4.2.2 时间特性要求 8 4.2.3 灵活性 8 4.3 输入输出要求 9 4.4 [数据管理能力要求] 9 4.5 [故障处理要求] 9 4.6 [其他专门要求] 9 5 系统运行环境规定 9 5.1 设备 9 5.2 支持软件 9 5.3 [接口] 10 5.4 [控制] 10 1引言 1.1[编写目的] 　　说明编写这份需求说明书的目的，指出预期的读者。 背景 说明待建设的数据库及其应用系统的名称 说明本数据库系统的学科特点，建设的目的，服务对象，预期成果等。 说明支持本数据库系统建设的项目来源 说明本数据库系统和其他数据库系统之间的关系 [定义] 　　列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 [参考资料] 列出有关的参考资料。 本项目的经核准的计划任务书或合同、上级机关批文； 属于本项目的其他已发表的文件； 本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。 数据需求说明 2.1 数据来源说明 详细说明本数据库内容的主要来源: 如果是从文献中摘录数据，逐一注明文献的名称和出处等基本信息； 如果是来自于相关的科研课题，简要说明课题背景信息，包括课题名称，课题支持机构，课题负责人，课题研究的主要内容等； 如果是通过镜像、购买、交换或者下载等手段获取的数据，说明出处； 实验、观测、统计调查等数据，需说明相关的仪器、设备、过程、方法等基本信息背景； 其它数据来源也请根据情况说明数据产生、收集的基本背景。 2.2 数据约定 说明本数据库对数据要求的制约，也作为数据采集、加工的基本原则和规范，基本内容包括： 时间范围约定：约定数据库数据的时间跨度； 空间范围约定：约定数据库数据的空间范围； 学科范围约定：说明数据所属（或所涉及）的学科范围； 数据量：说明计划本数据库将来的数据容量（如多少MB或多少条记录等）； 数据精度约定：数值数据约定数据的量纲（度量单位），精度，有效值范围等；图像数据约定数字图像的解析度；在数据是非数字量的情况下，给出每一种合法值的形式和含意； 语言约定：约定数据库数据表述的语言； 数据类型约定：约定数据库数据的基本类型，如图形、图像、文本、数