2009-10-25

中华人民共和国国家标准 术语数据库开发文件编制指南

1范围

本部分规定了术语数据库(简称"术语库")的主要开发文件及其内容、编写原则和管理要求。

本部分适用于术语库的研究、开发、维护及其管理工作,其他涉及术语数据处理的工作也可参照使用。

2规范性引用文件

下列文件中的条款通过本部分的引用而成为本部分的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本部分,然而,鼓励根据本部分达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本部分。

GB/T 7713 科学技术报告、学位论文和学术论文的编写格式

GB/T 7714 文后参考文献著录规则 (neq ISO/DIS 690)

GB/T 8567-1988 计算机软件产品开发文件编制指南

GB/T 9704 国家机关公文格式

GB/T 9705 文书档案案卷格式

GB/T 11822 科学技术档案案卷构成的一般要求

GB/T 13725-xxxx 建立术语数据库的一般原则与方法

GB/T 15237 术语学基本词汇(eqv ISO 1087-90)

GB/T 15387.2-xxxx 术语数据库开发指南

GB/T 15834 标点符号用法

GB/T 15835 出版物上数字用法的规定

GB/T 16786-1997 术语工作 计算机应用 数据类目(eqv ISO/DIS 12620-1996)

GB/T 17532-1998 术语工作 计算机应用 词汇 (eqv ISO/DIS 1087-2-2:96)

3 术语和定义

GB/T 15237.1-2000、GB/T 16786-1997、GB/T 17532-1998确立的术语和定义适用于本部分。为了便于使用,本部分重复了其中的部分术语和定义。

3.1术语term

在特定专业领域中一般概念的词语指称。

[GB/T 15237.1—2000,3.4.3]

3.2数据库 data base

常期储存在计算机中,有组织、可共享的数据集合。

[GB/T 17532-1998,7.5]

3.3术语数据库terminological database

包含术语数据的数据库。

[GB/T 17532—1998,7.6]

3.4记录 record

作为一个单位来对待的数据元的集。

[GB/T 17532-1998,7.9]

3.5数据元 data element

在一定的上下文中具有区别特征的数据单元。

[GB/T 17532—1998,7.11]

3.6数据字段 data field

为特定的数据元而保存在一个记录中的变长或定长的部分。

[GB/T 17532—1998,7.12]

3.7数据类目 data category

数据元类型 data element type

关于给定数据字段的类型说明。

[GB/T 17532—1998,7.14]

3.8标识符 identifier

用于标识或命名一个数据类目的一个或多个字符

[GB/T 17532—1998,7.15]

3.9术语条目 terminological entry

术语数据集合中所包含的关于一个概念的术语数据。

[GB/T 17532—1998,3.22]

4总则

4.1编制文件的确定

应根据GB/T 13725-xxxx中表1 的要求选择编制文件,并根据所开发的术语库系统的规模、使用目的及不同用户来确定所要编制文件的类型与内容。

4.2文件的分类和用途

按文件的性质,术语库开发文件一般可分为以下几类:

a) 依据性文件:是项目立项的依据,例如项目建议书、可行性研究报告、系统开发任务书、专家组评审报告等;

b) 管理性文件:供开发人员和项目管理人员使用,例如工作计划书、(运行)管理守则等;

c) 技术性文件:供开发人员和系统管理人员使用,例如数据要求说明书、功能要求说明书、硬件要求说明书、软件要求说明书、概念模式设计说明书、逻辑模式设计说明书、物理模式设计说明书、程序设计说明书、设计审查报告等;

d) 成果性文件:通常需要报上级主管部门,例如研制总结报告、技术报告、测试分析报告、技术资料及其审查报告、用户使用报告、验收报告等;

e) 使用性文件:供数据加工人员、操作人员、系统管理人员及用户使用,例如著录手册、标引规则、数据录入规则、录入工作单或采集卡、操作手册、使用手册、维护手册、数据字典等。

4.3文件的合并与细分

根据需要,4.2中所述文件可以相互合并或再细分。由于使用者不同,各文件的内容允许重复,也允许文件之间相互引用,但不同文件的内容应有所侧重。

4.4文件编制的一般原则

文件编制的一般原则是:

a) 文件中应使用国家规范文字;

b) 文件中使用的标点符号, 应符合GB/T 15834的规定;

c) 文件中出现的数字,应符合GB/T 15835和其他有关标准的规定;

d) 术语、符号、计量单位应符合有关国家标准的规定,必要时,应设立专门章节对文件中出现的术语、符号进行定义,文件中所用术语、符号及计量单位必须前后一致;

e) 文件后参考文献的著录,应符合GB/T 7714的规定;

f) 应根据文件的类型和用途,遵照GB/T 9704、GB/T 7713编排文件格式。

5主要文件的内容和编写要求

5.1项目建议书

该文件阐明建立术语库的目的、意义(社会效益和经济效益),预期目标,计划规模,所需条件(包括经费、硬件、软件、人员),拟完成的时间等。应突出说明该项目的必要性、迫切性和可行性。根据需要还应附上可行性研究报告(见5.2)以及国内外同类术语库开发情况调研报告等有关背景资料。

5.2可行性研究报告

该文件目的在于论证术语库在经济、技术、法律、知识产权及标准化等方面的可行性。

其内容一般应包括:

a) 一般背景说明,例如项目名称,提出者,承担者,合作者及其责任、权利、义务和分工,组织机构等;

b) 必要性分析;

c) 可行性分析,例如软件、硬件、人员、经费和其他相关的开发环境、所建议的系统及工作方案在经济、技术、管理体制和管理水平、人员配备及培训、其他配套条件和法律上的可行性;

d) 技术方案及实施,例如术语库的用途、规模、功能(见GB/T 15387.2-xxxx中第5章)、服务内容(见GB/T 13725-xxxx中6.5)、完成时间、对所建议系统的概要说明、开发工作和其他相关工作的内容和工作量;

e) 项目进度;

f) 经费概算;

g) 效益和风险分析;

h) 其他相关问题;

i) 结论,根据论证条件作出结论,例如建议项目立即立项、暂缓立项或不可行。

5.3系统开发任务书

该文件一般为上级机构或委托单位对项目建议书的核准性文件。

其形式可以有三种:

a) 任务书;

b) 合同书;

c) 协议书。

其内容至少应包括任务批准单位、接受单位或委托单位、承办单位;任务内容(包括系统目标、规模,对系统的各项要求),完成时间,验收方法和评价标准;核拨的经费,提供的条件(包括设备、人员及其他需要的条件)以及违约的惩处等。

5.4工作计划及任务分配书

该文件的编制是为了合理地计划和安排项目开发工作的任务分配、进度、人员、经费和资源,以期达到优化项目开发过程的目的,是检查各项工作的依据之一。

其内容一般包括:

a) 一般背景说明;

b) 开发环境,例如硬件、软件、人员配备及培训、组织机构、经费、术语源等;

c) 工作计划和流程图;

d) 工作任务的分解,例如分阶段的工作计划和任务、时间安排等;

e) 合作单位(人)及其分工,工作内容和工作量及其指标;

f) 组织与协调,例如各阶段和各合作单位所需设备、人员、经费等资源的调配与衔接,开发中的关键问题及其说明,各阶段工作的衔接,各单位工作的衔接;

g) 验收与评价的方法和标准;

h) 项目参与者的职责与权利,奖惩措施。

5.5数据要求说明书

术语库收录的数据应符合GB/T 13725-xxxx 中6.3 和6.4的要求,并遵照GB/T 13725-xxxx中6.3.2选择数据类目。

该文件通常供软件设计人员使用,也是选择系统用软件和硬件的依据之一,它与功能要求说明书(见5.6)、硬件要求说明书(见5.7)、软件要求说明书(见5.8)共同构成对系统的要求文件。其内容允许与数据字典(见5.13)、著录手册(见5.14)有所重复。

数据要求说明书内容一般包括:

a) 一般背景说明;

b) 数据描述,例如术语库收录术语的专业领域、术语条目数量、数据类型、数据类目、语种等的详细说明;

c) 数据可靠性保障,例如数据的来源、数据的采集、整理和审定等;

d) 对数据处理环境的要求,例如硬件、软件、源数据、专家、工作人员等;

e) 其他。

5.6功能要求说明书

该文件应根据用户需要并遵照GB/T 13725-xxxx 第8章和GB/T 15387.2-xxxx第5章的有关规定确定术语库功能要求。

其内容一般包括:

a) 一般背景说明;

b) 术语库整体功能要求说明(见GB/T 15387.2-xxxx第5章),还包括图、表、公式、特殊的符号、语音和图像等的处理能力,数据的批处理、数据通信等的处理要求说明;

c) 相应硬件的支持功能及其说明;

d) 相应软件的支持功能及其说明;

e) 数据库系统的管理功能及其说明;

f) 其他。

5.7硬件要求说明书

该文件应根据数据数量、类型,软件环境,术语库功能要求等条件并遵照GB/T 13725-xxxx中6.2.2的有关规定确定硬件要求。

其内容一般包括:

a) 一般背景说明;

b) 需求规定,例如对功能、性能、数据处理速度、系统输入输出能力、兼容性、内存和外存的存储容量、网络支持以及可扩充能力等的要求;

c) 运行环境规定,例如对系统的组成、设备配套、软件支持环境、接口等的要求;

d) 硬件研究选型报告;

e) 配套使用的硬件和软件目录及说明;

f) 其他。

5.8软件要求说明书

该文件应根据数据数量、类型,硬件环境,术语库功能要求等条件并遵照GB/T 13725-xxxx中6.2.3的有关规定确定软件要求。

其内容一般包括:

a) 一般背景说明;

b) 需求规定,例如对功能、性能、精度、时间特性、灵活性、输入输出、数据管理能力、故障处理能力及网络查询功能等的要求;

c) 运行环境规定,例如对设备、配套软件、接口、控制、管理等的要求;

d) 软件选择研究报告;

e) 配套软件目录及说明;

f) 需开发的软件及说明;

g) 其他。

5.9概念模式设计说明书

该文件应说明概念设计所采用的方法,模式和子模式。它与逻辑模式设计说明书(见5.10)、物理模式设计说明书(见5.11)、程序设计说明书(见5.12)共同构成系统设计文件。

其内容一般包括:

a) 一般背景说明;

b) 数据实体及属性类型目录及其说明(见5.13);

c) 实体及属性间关系类型(1:1,1:N,M:N)及其说明;

d) 各局部E-R图(实体-关系图)

e) 整体的基本E-R图(见GB/T 13725-xxxx中6.3.3.3);

f) 其他。

5.10逻辑模式设计说明书

该文件应根据概念模式设计说明书和所使用的数据库系统的类型进行编写,给出所使用的每个数据结构的名称、标识符以及它们之中每个数据类目、记录、文件的标识、定义、长度及相互关系。

5.11物理模式设计说明书

该文件的内容一般应包括:

a) 数据库对内存使用的要求,包括设备限制和设计考虑;

b) 所使用的外存设备及外存空间的组织,包括索引区、数据块的组织与划分;

c) 说明所有脱机数据存储的形式、媒体和存储要求;

d) 存取方式,说明存取的物理关系;

e) 存取限制,安全性和保密考虑;

f) 其他。

5.12程序设计说明书

该文件向程序设计人员提供系统对程序的要求、运行环境、设计特性等,应遵照GB/T 8567-1988附录F编写。

5.13数据字典

该文件是设计、建立、维护和管理数据库的工具,也是进行系统设计的依据。

其内容一般包括:

a) 一般背景说明;

b) 每个数据类目的名称、名称缩写、助记符号、标识符;

c) 每个数据类目的定义;

d) 对每个数据类目的说明,包括字段数据类型(见GB/T 15387.2-xxxx中4.4)、字段长度 (包括使用定长或不定长字段、占用字节数,若使用定长字段或超长字段应采用的技术处理手段) 、取值的要求、字段的强制级别(见GB/T 15387.2-xxxx中4.7)、字段间关系(见GB/T 15387.2-xxxx中4.6)、重复性、组合性、用途、约束与限制(存取和修改权限等)、影响面(该数据类目涉及到的屏幕显示、输入输出格式和方式、存取要求、默认值等);

e) 记录、文件、模式、子模式等的名称及其同义名称、标识符和相关的信息;

f) 其他。

5.14著录手册

该文件是数据采集和选取、数据分析和描述以及数据规范化的依据之一,是影响数据质量、关系到术语库的使用以及同类术语库之间数据交换的重要文件,它与标引规则(见5.15)、数据采集卡或录入工作单(见5.16)、数据录入规则(见5.17)共同构成数据加工规范化文件。

其内容一般包括:

a) 一般背景说明;

b) 编写依据及适用范围;

c) 著录的项目,项目的名称、定义、代码及标识符(可引用5.5、5.13);

d) 规定各著录项的表达方法和具体要求(包括数据源依据、著录格式、重复性、组合性、是否允许空缺,是否需要和允许设定默认值等);

e) 著录顺序和著录方法;

f) 必要的示例;

g) 著录参考依据(例如有关标准、代码表等);

h) 其他。

5.15标引规则

该文件是数据分析和数据规范化的依据之一,是影响术语数据的检索效率、关系到术语库的使用以及同类术语库之间数据交换的重要文件。

其内容一般包括:

a) 一般背景说明;

b) 编写依据及适用范围;

c) 主题分析的依据及标引词的来源(例如叙词表);

d) 分类标引的依据及所使用的分类法;

e) 标引规则、方法和工作程序;

f) 必要的示例;

g) 标引参考依据(例如有关标准、叙词表、分类法等);

h) 其他。

5.16数据采集卡或录入工作单

数据采集卡或录入工作单是数据采集和著录的载体。采集卡或工作单上的数据类目的布局应遵从著录的顺序,也要考虑采集卡或工作单上设计空间的利用,以及与屏幕工作单的对应。

其内容一般应包括:

a) 数据采集卡或录入工作单名称;

b) 设计者及设计时间;

c) 字段名称;

d) 字段标识符;

e) 与数据加工相关的责任说明;

f) 其他。

5.17数据录入规则

该文件是录入过程应遵循的规范,应对录入顺序、方法、特殊问题的处理(例如特殊字符、公式、符号,多语种对应的标音、转写、拉丁化等)、数据校验、数据安全、数据修改与更新等作出规定或说明,还应该对数据录入的管理(包括源数据管理、记录媒体管理、现场管理等)作出规定。

5.18数据加工工作规程

该文件是数据加工过程中的工作约定性文件,一般包括数据采集、选取,著录、标引,录入,验收等各项工作的工作程序、方式,数据的整理、利用、质量检验等一系列数据加工工作的组织和管理细则。

5.19设计审查报告

该文件是术语库测试及验收的依据之一,一般在每个阶段工作完成之后都要有设计审查,是否都需要编写设计审查报告以及编写内容的繁简可根据需要决定。

其内容一般包括:

a) 一般背景说明;

b) 研制工作概况;

c) 技术方案和研制过程;

d) 技术文件的完整性和贯彻的情况;

e) 是否满足设计要求和实际达到的水平;

f) 存在的问题和解决措施;

g) 结论及改进意见。

5.20测试计划书

该文件提供对整个系统进行测试的计划,包括测试大纲、过程和步骤说明,并提供测试结果的分析与评价标准,其内容应遵照GB/T 8567-1988附录K编写。

5.21测试报告

该文件的内容包括对测试结果进行的分析、对系统进行的评价并对系统的改进提出的建议,是系统交付使用的依据。其内容应遵照GB/T 8567-1988附录L编写。

5.22验收报告

该文件是对项目进行技术、经济、法律等方面综合评定的审查文件。

其内容一般包括:

a) 一般背景说明(包括验收的时间、地点、方法、验收人员及分工等);

b) 提交审查验收的设计依据、测试结果以及其他的有关文件目录及原始资料;

c) 审查验收的内容、具体项目及审查验收的结果;

d) 与国内外同类技术或系统的比较报告

e) 查新报告;

f) 对系统的评价;

g) 结论性意见;

h) 不同意见备忘录;

i) 审查验收单位(人员)盖章(签名)。

5.23操作手册

该文件向一般操作人员提供系统运行环境和操作的具体步骤、方法、要求和其他有关知识,其内容应参照GB/T 8567-1988附录I编写。

5.24用户手册

该文件向用户提供该系统的特点、要求的配置、运行环境、功能、性能,系统的要求与限制以及使用方法、故障或出错处理、一般维护等,其内容应遵照GB/T 8567-1988附录H编写。

5.25维护手册

该文件向系统管理员提供理解系统结构、软硬件配置、各模块和程序及其运行环境和维护步骤以及数据更新与维护所必需的资料。

其内容一般包括:

a) 一般背景说明;

b) 系统维护的背景知识(包括运行环境、数据结构、模式和子模式、程序模块等);

c) 系统维护的基本要求和规则(包括维护权限、维护过程记录、运行和维护记录等);

d) 维护指南

— 日常维护,例如日常数据的增删、修改与更新,数据库的备份、恢复、再启动、数据库重组等;

— 需变化系统物理级(例如硬件配置或数据库布局变化)而要求的维护,例如指针的重新配置,改变块规模、缓冲区规模、主区及溢出区等;

— 需变化系统逻辑级(例如用户要求新的数据结构,增加新的数据类目等)而要求的维护,示例可参见GB/T 13725-xxxx中6.3.3.4和GB/T 15387.2-xxxx第4章;

— 需变化数据库管理系统(例如变换软件或软件版本等)而要求的维护,例如将数据从一种数据库系统转换到另一种数据库系统;

— 其他情况;

e) 其他。

5.26项目工作总结报告

该文件是术语库系统开发工作的总结,应包括研制报告、技术报告等。

其内容一般包括:

a) 研制工作概况、进程,经费结算;

b) 技术方案和技术实现;

c) 术语库系统性能、水平及评价;

d) 是否达到任务书的要求;

e) 经验和下一步的计划。

5.27运行(管理)守则

该文件是使用单位管理术语库的依据,由使用单位根据需要确定编写内容。

6文件的管理

6.1文件的编制

应根据术语库建立的基本过程(见GB/T 13725-xxxx第7章)编制各个阶段相应的文件。

6.2文件的分类管理

应根据需要和文件的分类(见4.2)建立文件管理细则,对各类文件的保管、借阅、复制、修改等作出具体规定。

6.3文件的归档

完整的系统开发文件档案及文件的归档应遵照下列国家标准:

a. GB/T 9705 文书档案案卷格式;

b. GB/T 11822 科学技术档案案卷构成的一般要求。

-完-

没有评论:

博客归档