中科院数据库建设技术文档参考规范Word文档下载推荐.docx
《中科院数据库建设技术文档参考规范Word文档下载推荐.docx》由会员分享,可在线阅读,更多相关《中科院数据库建设技术文档参考规范Word文档下载推荐.docx(27页珍藏版)》请在冰豆网上搜索。
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[编写目的]
说明编写这份需求说明书的目的,指出预期的读者。
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[控制]
说明控制该系统的运行的方法和控制信号,并说明这些控制信号的来源。
数据库元数据需求规格书
1前言…………………………………………………………………………13
1.1编写目的……………………………………………………………….13
1.2建库背景……………………………………………………………….13
1.3建库目标……………………………………………………………….13
1.4参考资料……………………………………………………………….13
1.5主要参与人员………………………………………………………….13
2元素著录结构……………………………………………………………….13
3需求元素设置……………………………………………………………….13
4需求元素属性……………………………………………………………….14
5代码表……………………………………………………………………….14
6元数据标准映射表………………………………………………………….15
7查询功能需求……………………………………………………………….15
8系统其它功能需求………………………………………………………….15
9需求规格书确认与其他说明……………………………………………….15
1前言
1.1编写目的
说明编写这份需求说明书目的,指出预期的读者。
1.2建库背景
说明本数据库建设的基本背景,包括学科特点、范围以及建设的意义的等。
1.3建库目标
详细说明并列举本数据库建设预期达到的主要目标。
1.4参考资料
列出本份需求规格书主要参考资料,如参考的国际、国内元数据标准,包括标准名称,版本号,发展单位等。
1.5主要参与人员
列出参加本次需求规格书分析的主要人员名单。
2元素著录结构
本著录结构是经仔细分析确认的数据库数据著录所需元素及元素的先后排序(系统自动产生值或者设定固定值的元素因为不需要人工著录,所以不包括在内),作为开发人员开发数据库数据录入界面之参考,同时也作为数据库分析、设计人员理解数据库需求之参考。
3需求元素设置
需求元素设置表主要是把数据库所需要的字段经系统化、结构化与Metadata标准化之后,列成表格供系统分析人员建数据库时设定字段所用,同时也供程序设计人员在撰写程序时参考使用。
需求元素设置表各项说明如下:
数据库所需元素之中文名称。
✧英文名称:
元素名称对应之英文名称。
元素数据类型包括:
text、varchar、varchar2等存放文字型态的数据。
字段所需之空间,以byte为单位。
英文名称
4需求元素属性
5代码表
列出在需求元素属性表中,如果元素的属性一栏为“下拉式菜单”,请详细列出该下拉式菜单的内容。
代码内容
6元数据标准映射表
元数据标准映射表是作为该数据库和国际标准的接轨,以及与国际、国内间其它数据库作XML数据交换的关键机制。
将“需求元素建置表”中的每一个元素映射到选定参考标准对应的元素。
7查询功能需求
✓简单查询:
表格中“简单查询”一栏标有“○”者可以作为系统简单查询的条件
✓高级查询:
表格中“高级查询”一栏标有“●”者作为系统高级查询的条件
✓简要显示:
表格中“简要显示”一栏标有“△”者作为“简单查询”和“高级查询”结果的简要显示元素
✓详细显示:
表格中“详细显示”一栏标有“▲”者作为“简单查询”和“高级查询”结果的详细显示元素
简单查询
高级查询
简要显示
详细显示
8系统其它功能需求
系统其它功能需求说明。
9需求规格书确认与其他说明
建库单位负责人确认本需求规格书是否符合其需求,若不符合,请说明原因。
数据库设计说明书
1引言19
1.1编写目的19
1.2背景19
1.3[定义]19
1.4[参考资料]19
2外部设计19
2.1标识符的状态19
2.2[使用它的程序]19
2.3约定20
2.4[专门指导]20
2.5支持软件20
3结构设计20
3.1概念结构设计20
3.2逻辑结构设计20
3.3[物理结构设计]20
4运用设计21
4.1数据字典设计21
4.2安全保密设计21
说明编写这份数据库设计说明书的目的,指出预期的读者。
a.说明待建设的数据库及其应用系统的名称
b.说明本数据库系统的学科特点,建设的目的,服务对象,预期成果等。
c.说明支持本数据库系统建设的项目来源
d.说明本数据库系统和其他数据库系统之间的关系
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引言………………………………………………………………………………25
1.1编写目的……………………………………………………………………25
1.2背景…………………………………………………………………………25
1.3定义…………………………………………………………………………25
1.4参考资料……………………………………………………………………25
2总体设计…………………………………………………………………………25
2.1需求规定……………………………………………………………………25
2.2运行环境……………………………………………………………………25
2.3基本设计概念和处理流程…………………………………………………25
2.4结构……………………………………………………………………..…25
2.5功能要求与程序的关系……………………………………………………26
2.6人工处理过程………………………………………………………………26
2.7尚未解决的问题……………………………………………………………26
3接口设计…………………………………………………………………………26
3.1用户接口……………………………………………………………………26
3.2外部接口……………………………………………………………………26
3.3内部接口……………………………………………………………………26
4运行设计…………………………………………………………………………26
4.1运行模块组合………………………………………………………………26
4.2运行控制……………………………………………………………………26
4.3运行时间……………………………………………………………………27
5系统数据结构设计………………………………………………………………27
5.1逻辑结构设计要点…………………………………………………………27
5.2物理结构设计要点…………………………………………………………27
5.