Some standard content:
ICS01.020
National Standard of the People's Republic of China
GB/T15387.1—2001
Replaces GB/T15387.1—1994
Guidelines for the documentation for developing terminology database
Promulgated on 2001-11-14
General Administration of Quality Supervision, Inspection and Quarantine of the People's Republic of China
Implementation on 2002-06-01
2 Normative references
3 Terms and definitions
Contents and writing requirements of main documents
Document management
GB/T15387.1—2001
GB/T15387 is divided into two parts:
Part 1: Guidelines for the documentation for developing terminology database: Part 2: Guidelines for developing terminology database
This part replaces GB/T15387.1-1994 "Guidelines for the Preparation of Terminology Database Development Documents". The main changes of this part compared with GB/T15387.1-1994 are as follows: 1. A chapter on terms and definitions has been added;
"Expert Group Review Report" has been added to the supporting documents (see 4.2a); 2. The level of the content of the feasibility study report has been adjusted (see 5.2); GB/T15387.12001
listed "Methods and standards for acceptance and evaluation" in the work plan as a separate item (see 5.4g); the hardware requirements specification has added requirements for network support (see 5.7); the software requirements specification has added Add network query function (see 5.8); according to the requirements of GB/T1.1-2000 "Guidelines for Standardization Work Part 1: Structure and Writing Rules of Standards", the standard format has been modified and adjusted.
GB/T15837 is one of the series of national standards for terminology databases. The series of standards that have been issued are: GB/T13725-2001 General principles and methods for establishing terminology databases GB/T13726--1992
Magnetic tape format for recording and exchanging terminology and dictionary entries GB/T15625-2 001
Guidelines for the evaluation of terminology database technology
GB/T16785—1997
Coordination of concepts and terms in terminology work
Data categories for computer application of terminology work
GB/T16786-1997
GB/T17532--1998
Computer application of terminology work
GB/T18155-2000 Computer application of terminology work Machine-readable terminology interchange format (MARTIF) Negotiation and exchange This part is exchanged by the National Proposed by the Technical Committee on Terminology Standardization. This part is under the jurisdiction of the China Standards Research Center. This part was drafted by the China Standards Research Center. This part is interpreted by the National Technical Committee on Terminology Standardization. The main drafters of this part are Ye Sheng, Li Mingfei, Zhang Zhiyun, Xiao Yujing, Lu Lili, and Xu Junrong. 1 Scope
Guidelines for the Preparation of Terminology Database Development Documents
GB/T15387.1-2001
This part specifies the main development documents of the terminology database (referred to as "terminology database") and their contents, compilation principles, and management requirements. This This part is applicable to the research, development, maintenance and management of terminology databases, and can also be used as a reference for other work involving terminology data processing.
2 Normative references
The clauses in the following documents become the clauses of this part through reference in this part. For any dated referenced document, all subsequent amendments (excluding errata) or revisions are not applicable to this part. However, parties to agreements based on this part are encouraged to study whether the latest versions of these documents can be used. For any undated referenced document, its latest version applies to this part GB/T7713 Format for scientific and technological reports, dissertations and academic papers (GB/T7713-1987) GB/T7714 Rules for the citation of references after the text (GB/T7714-1987, ISO/DIS690, NEQ) GB/T8567-1988 Guidelines for the preparation of computer software product development documents GB/T9704 Format for official documents of national administrative agencies (GB/T9704-1999) GB/T9705 Format for document archives (GB/T9705-1988) GB/T1 1822 General requirements for the composition of scientific and technological archives (GB/T11822-1989) GB/T13725-2001 General principles and methods for establishing terminology databases GB/T15237.1-2000 Vocabulary of terminology work Part 1: Theory and application (ISO1087-1:2000, EQV) GB/T15387.2-2001 Guide to the development of terminology databases GB/T15834 Use of punctuation marks (GB/T15834-1995) GB/T15835 Rules for the use of numbers in publications GB/T15835-1995 GB/T16786-1997 Terminology Working Computer Application Data Category (ISO/DIS12620:1996, EQV) GB/T17532-1998 Terminology Working Computer Application Vocabulary (ISO/DIS1087-2-2:1996, EQV) 3 Terms and Definitions
The terms and definitions established in GB/T15237.1-2000, GB/T16786-1997 and GB/T17532-1998 apply to this part. For ease of use, this part repeats some of the terms and definitions. 3.1
Terms term
The term refers to the general concept in a specific professional field. [GB/T15237.1-2000,3.4.3]
Databasedatabase
A collection of organized and sharable data stored in a computer for a long period of time. [GB/T17532—19987.5]
terminological database
Terminological database
GB/T15387.1—2001
A database containing terminological data.
［GB/T17532—1998,7.6]
Recordrecord
A collection of data elements treated as a unit. [GB/T17532-1998,7.9]
Data elementdataelement
A data unit with distinguishing characteristics in a certain context. [GB/T17532--1998,7.117
datafielddatafield
The variable-length or fixed-length part of a record stored for a specific data element. [GB/T17532-1998,7.12]
datacategorydatacategory
dataelementtypedataelementtype
A description of the type of a given data field. [GB/T17532-1998,7.14]
identifieridentifier
One or more characters used to identify or name a data category. [GB/T17532-1998,7.15]
terminological entryterminological data about a concept contained in a terminological data set. [GB/T17532--1998,3.22]bZxz.net
4 General
4.1 Determination of the preparation documents
The preparation documents should be selected according to the requirements of Table 1 in GB/T13725-2001, and the type and content of the documents to be prepared should be determined according to the scale, purpose of use and different users of the terminology system to be developed. 4.2 Classification and use of documents
According to the nature of the documents, term base development documents can generally be divided into the following categories: a) Basis documents: the basis for project establishment, such as project proposals, feasibility study reports, system development task books, expert group review reports, etc.
b) Management documents: for developers and project managers, such as work plans, (operation) management rules, etc. c) Technical documents: for developers and system managers, such as data requirements specifications, functional requirements specifications, hardware requirements specifications, software requirements specifications, conceptual model design specifications, logical model design specifications, etc. Design specification, physical model design specification, program design specification, design review report, etc.; d) Achievement documents: usually need to be reported to the superior competent department, such as research and development summary report, technical report, test analysis report, technical data and its review report, user use report, acceptance report, etc.; e) Usability documents: for data processing personnel, operators, system management personnel and users, such as cataloging manuals, indexing rules, 2
GB/T15387.1—2001
data entry rules, entry work sheets or acquisition cards, operation manuals, user manuals, maintenance manuals, data dictionaries, etc. 4.3 Merging and subdividing files
According to needs, the files described in 4.2 can be merged or subdivided. Due to different users, the contents of each file are allowed to be repeated, and files are allowed to be referenced from each other, but the contents of different files should have different emphases. 4.4 General principles of document preparation
The general principles of document preparation are:
a) National standard characters should be used in the document; b) Punctuation marks used in the document should comply with the provisions of GB/T15834; c) Numbers appearing in the document should comply with the provisions of GB/T15835 and other relevant standards; d) Terms, symbols, and measurement units should comply with the provisions of relevant national standards. If necessary, a special chapter should be set up to define the terms and symbols appearing in the document. The terms, symbols, and measurement units used in the document must be consistent; e) The references after the document should comply with the provisions of GB/T7714; f) The document format should be arranged in accordance with GB/T9704 and GB/T7713 according to the type and purpose of the document. 5 Contents and writing requirements of main documents
5.1 Project proposal
This document explains the purpose and significance (social and economic benefits), expected goals, planned scale, required conditions (including funds, hardware, software, personnel), and the time to be completed of the establishment of a terminology database. The necessity, urgency and feasibility of the project should be highlighted. If necessary, a feasibility study report (see 5.2) and relevant background information such as a survey report on the development of similar terminology bases at home and abroad should also be attached. 5.2 Feasibility Study Report
The purpose of this document is to demonstrate the feasibility of the terminology base in terms of economy, technology, law, intellectual property rights and standardization. Its content should generally include:
a) General background description, such as the project name, proposer, undertaker, collaborators and their responsibilities, rights, obligations and division of labor, organizational structure, etc.;
b) Necessity analysis;
c) Feasibility analysis, such as software, hardware, personnel, funds and other related development environment, the economic, technical, management system and management level, staffing and training, other supporting conditions and legal feasibility of the proposed system and work plan; d) Technical plan and implementation, such as the purpose, scale, Function (see Chapter 5 of GB/T15387.2-2001), service content (see 6.5 of GB/T13725-2001), completion time, summary of the proposed system, content and workload of development work and other related work;
e) Project schedule;
f) Budget estimate;
g) Benefit and risk analysis;
h) Other related issues;
i) Conclusion, make a conclusion based on the demonstration conditions, such as recommending that the project be established immediately, postponed or not feasible. 5.3 System Development Task Book
This document is generally an approval document for the project proposal by the superior organization or the entrusting unit. There are three forms:
a) Task book;
b) Contract;
c) Agreement.
Its contents should at least include the task approving unit, the accepting unit or the entrusting unit, and the undertaking unit; the task content (including the system objectives, scale, and various requirements for the system), completion time, acceptance method and evaluation criteria; the allocated funds, the conditions provided (including equipment, personnel and other 3
GB/T15387.1—2001
required conditions) and the penalties for breach of contract. 5.4 Work Plan and Task Assignment
This document is prepared to reasonably plan and arrange the task assignment, progress, personnel, funds and resources of the project development work, in order to achieve the purpose of optimizing the project development process. It is one of the bases for checking various tasks. Its contents generally include:
a) General background description;
b) Development environment, such as hardware, software, staffing and training, organizational structure, funds, terminology source, etc.; e) Work plan and flow chart;
d) Decomposition of work tasks, such as phased work plans and tasks, time arrangements, etc.; e) Cooperating units (people) and their division of labor, work content and workload and their indicators; f) Organization and coordination, such as the allocation and connection of equipment, personnel, funds and other resources required for each stage and each cooperative unit, key issues in development and their description, the connection of work at each stage, and the connection of work of each unit; g) Acceptance and evaluation methods and standards;
h) Responsibilities and rights of project participants, and rewards and punishments. 5.5 Data Requirements Specification
The data included in the terminology database shall comply with the requirements of 6.3 and 6.4 of GB/T13725-2001, and the data categories shall be selected in accordance with 6.3.2 of GB/T13725-2001.
This document is usually used by software designers and is also one of the bases for selecting system software and hardware. It, together with the functional requirements specification (see 5.6), hardware requirements specification (see 5.7), and software requirements specification (see 5.8), constitute the system requirements document. Its content is allowed to overlap with the data dictionary (see 5.13) and the cataloging manual (see 5.14). The content of the data requirements specification generally includes: a) general background description;
b) data description, such as detailed description of the professional fields of the terms included in the terminology database, the number of terminology entries, data types, data categories, languages, etc.;
c) data reliability assurance, such as the source of data, data collection, collation and verification, etc.; d) requirements for the data processing environment, such as hardware, software, source data, experts, staff, etc.; e) others.
5.6 Functional Requirements Specification
This document should determine the functional requirements of the terminology database based on user needs and in accordance with the relevant provisions of Chapter 8 of GB/T13725-2001 and Chapter 5 of GB/T15387.2--2001.
Its contents generally include:
a) General background description;
b) Description of the overall functional requirements of the terminology database (see Chapter 5 of GB/T15387.2-2001), including the processing capabilities of graphs, tables, formulas, special symbols, voices and images, batch processing of data, data communication, etc.; c) Support functions of the corresponding hardware and their descriptions; d) Support functions of the corresponding software and their descriptions; e) Management functions of the database system and their descriptions; f) Others.
5.7 Hardware Requirements Specification
This document should determine the hardware requirements based on the data quantity, type, software environment, terminology database functional requirements and in accordance with the relevant provisions of 6.2.2 of GB/T13725-2001. The content generally includes:
a) General background description,
GB/T15387.1—2001
b) Requirements, such as requirements for functions, performance, data processing speed, system input and output capabilities, compatibility, memory and external storage capacity, network support and expandability; c) Operating environment requirements, such as requirements for system composition, equipment matching, software support environment, interface, etc.; d) Hardware research and selection report;
e) Hardware and software catalog and description for matching use; f) Others.
5.8 Software Requirements Specification
This document should be based on the data quantity, type, hardware environment, terminology library function requirements and other conditions and avoid reference to 6.2 in GB/T13725-2001.3. The software requirements are determined according to the relevant provisions of the Regulations. Its contents generally include:
a) General background description;
b) Requirements, such as requirements for functions, performance, accuracy, time characteristics, flexibility, input and output, data management capabilities, fault handling capabilities and network query functions;
c) Operating environment regulations, such as requirements for equipment, supporting software, interfaces, control, management, etc.; d) Software selection research report;
e) Supporting software catalog and description;
f) Developed software and description;
g) Others.
5.9 Conceptual model design specification
This document should explain the methods, models and sub-models used in the conceptual design. It, together with the logical model design specification (see 5.10), the physical model design specification (see 5.11) and the program design specification (see 5.12), constitute the system design document. Its contents generally include:
a) general background description;
b) data entity and attribute type directory and its description (see 5.13); c) relationship type between entity and attribute (1:1, 1?N, M:N) and its description; d) each local ER diagram (entity relationship diagram); e) overall basic ER diagram (see 6.3.3.3 of GB/T13725-2001); f) others.
5.10 Logical model design specification
This document should be written according to the conceptual model design specification and the type of database system used, giving the name and identifier of each data structure used, as well as the identification, definition, length and mutual relationship of each data category, record and file in them. 5.11 Physical model design specification
The contents of this document should generally include:
a) Database requirements for memory usage, including device restrictions and design considerations; b) Organization of external storage devices and external storage space used, including the organization and division of index areas and data blocks; c) Description of the form, media and storage requirements of all offline data storage; d) Access methods, description of the physical relationship of access; e) Access restrictions, security and confidentiality considerations; f) Others.
5.12 Program design specification
This document provides programmers with system requirements for programs, operating environment, design characteristics, etc., and should be written in accordance with Appendix F of GB/T8567--1988.
5.13 Data dictionary
GB/T15387.1—2001
This document is a tool for designing, establishing, maintaining and managing databases, and is also the basis for system design. Its contents generally include:
a) general background description;
b) the name, abbreviation, mnemonic symbol and identifier of each data category; c) the definition of each data category;
d) description of each data category, including field data type (see 4.4 of GB/T15387.2-2001), field length (including the use of fixed-length or variable-length fields, the number of bytes occupied, and the technical processing methods to be adopted if fixed-length fields or extra-long fields are used), value requirements, field mandatory level (see 4.7 of GB/T15387.2-2001), relationship between fields (see 4.6 of GB/T15387.2-2001), repeatability, combination, purpose, constraints and restrictions (access and modification permissions, etc.), impact area (screen display, input and output formats and methods, access requirements, default values, etc. involved in this data category); e) the name of record, file, mode, sub-mode, etc. and their synonymous names, identifiers and related information; f) others.
5.14 Cataloging Manual
This document is one of the bases for data collection and selection, data analysis and description, and data normalization. It is an important document that affects data quality, is related to the use of terminology bases, and data exchange between similar terminology bases. It, together with indexing rules (see 5.15), data collection cards or data entry worksheets (see 5.16), and data entry rules (see 5.17), constitute data processing normalization documents. Its contents generally include:
a) General background description;
b) Basis for compilation and scope of application;
c) Recorded items, item names, definitions, codes and identifiers (5.5 and 5.13 may be cited); d) Expression methods and specific requirements for each record item (including data source basis, record format, repetitiveness, combination, whether blanks are allowed, whether default values are required and allowed, etc.); e) Recording order and recording method;
f) Necessary examples;
g) Recording references (such as relevant standards, code tables, etc.); h) Others.
5.15 Indexing rules
This document is one of the bases for data analysis and data standardization. It is an important document that affects the retrieval efficiency of terminology data, is related to the use of terminology bases, and data exchange between similar terminology bases. Its contents generally include:
a) general background description;
b) basis for compilation and scope of application;
c) basis for subject analysis and source of indexing terms (such as thesaurus); d) basis for classification indexing and the classification method used; e) indexing rules, methods and working procedures; f) necessary examples;
g) reference basis for indexing (such as relevant standards, thesauri, classification methods, etc.); h) others.
5.16 Data collection card or entry work sheet
Data collection card or entry work sheet is the carrier of data collection and recording. The layout of data categories on the collection card or work sheet should follow the order of recording, and also consider the use of design space on the collection card or work sheet, as well as the correspondence with the screen work sheet. Its contents should generally include:
a) Name of data acquisition card or recording worksheet;6
b) Designer and design time;
c) Field name;
d) Field identifier;
e) Responsibility statement related to data processing; f) Others.
5.17 Data entry rules
GB/T15387.1—2001
This document is the specification that should be followed in the recording process. It should stipulate or explain the order and method of entry, the handling of special issues (such as special characters, formulas, symbols, phonetic notation, transcription, Latinization, etc. corresponding to multiple languages), data verification, data security, data modification and update, etc., and should also stipulate the management of data entry (including source data management, recording media management, on-site management, etc.). 5.18 Data Processing Procedures
This document is a work agreement document in the data processing process, generally including the work procedures and methods of data collection, selection, cataloging, indexing, input, acceptance, etc., as well as the organization and management details of a series of data processing work such as data collation, utilization, quality inspection, etc. 5.19 Design Review Report
This document is one of the bases for terminology library testing and acceptance. Generally, there must be a design review after the completion of each stage of work. Whether a design review report needs to be written and the complexity of the content can be determined according to needs. Its content generally includes:
a) General background description;
b) Overview of development work;
c) Technical plan and development process;
d) The integrity and implementation of technical documents; e) Whether it meets the design requirements and the actual level achieved; f) Existing problems and solutions;
g) Conclusions and suggestions for improvement.
5.20 Test Plan
This document provides a plan for testing the entire system, including the test outline, process and step description, and provides analysis and evaluation standards for test results. Its content should be written in accordance with Appendix K of GB/T8567-1988. 5.21 Test Report
This document includes analysis of test results, evaluation of the system and suggestions for system improvement, and is the basis for delivery of the system. Its content should be written in accordance with Appendix L of GB/T8567-1988. 5.22 Acceptance Report
This document is a review document for comprehensive evaluation of the project in terms of technology, economy, law, etc. Its contents generally include:
a) General background description (including acceptance time, location, method, acceptance personnel and division of labor, etc.); b) Design basis, test results and other relevant document catalogs and original materials submitted for review and acceptance; c) Review and acceptance content, specific items and review and acceptance results; d) Comparison report with similar technologies or systems at home and abroad; e) Novelty search report;
f) Evaluation of the system;
g) Concluding opinions;
h) Memorandum of different opinions;
i) Seal (signature) of the personnel of the review and acceptance unit. 5.23 Operation Manual
This document provides general operators with specific steps, methods, requirements and other relevant knowledge of the system operating environment and operation. Its content is 7
GB/T15387.1—2001
Should be written in accordance with Appendix I of GB/T8567—1988. 5.24 User Manual
This document provides users with the system's features, required configuration, operating environment, functions, performance, system requirements and limitations, usage methods, fault or error handling, general maintenance, etc. Its content should be written in accordance with Appendix H of GB/T8567-1988. 5.25 Maintenance Manual
This document provides system administrators with the necessary information to understand the system structure, software and hardware configuration, various modules and programs, their operating environment and maintenance procedures, as well as data update and maintenance. Its contents generally include:
a) General background description;
b) Background knowledge of system maintenance (including operating environment, data structure, mode and sub-mode, program module, etc.);c) Basic requirements and rules for system maintenance (including maintenance authority, maintenance process record, operation and maintenance record, etc.);d) Maintenance guide
Daily maintenance, such as daily data addition, deletion, modification and update, database backup, recovery, restart, database reorganization, etc.; Maintenance required due to changes in the physical level of the system (such as changes in hardware configuration or database layout) , such as pointer reconfiguration, change of block size, buffer size, main area and overflow area, etc.; maintenance required by changes in system logic level (such as users requiring new data structure, adding new data categories, etc.), examples can be found in 6.3.3.4 of GB/T13725-2001 and Chapter 4 of GB/T15387.2-2001; maintenance required by changes in database management system (such as changing software or software version, etc.), such as converting data from one database system to another; other situations:
e) Others.
5.26 Project work summary report
This document is a summary of the development work of the terminology system, which should include development report, technical report, etc. Its content generally includes:
a) Overview of development work, progress, and budget settlement; b) Technical plan and technical implementation;
c) Performance, level and evaluation of the terminology system; d) Whether the requirements of the task book are met;
e) Experience and next steps.
5.27 Operation (management) rules
This document is the basis for the user to manage the terminology database, and the user shall determine the content according to the needs. 6 Document management
6.1 Document preparation
The corresponding documents at each stage shall be prepared according to the basic process of establishing the terminology database (see Chapter 7 of GB/T13725-2001). 6.2 Classification management of documents
Detailed document management rules shall be established according to the needs and classification of documents (see 4.2), and specific provisions shall be made for the storage, borrowing, copying, and modification of various types of documents.
6.3 Filing of documents
The complete system development document archive and the filing of documents shall comply with the following national standards: a) GB/T9705 Document archive file format; b) GB/T11822 General requirements for the composition of scientific and technological archive files. 8
GB/T15387.1-2001
National Standard of the People's Republic of China
Guide to the Preparation of Terminology Database Development Documents
GB/T15387.1-—2001
Published by China Standards Press
No. 16, Sanlihebei Street, Fuxingmenwai, Beijing
Postal Code: 100045
Tel: 6852394668517548
China Standards Press Printed by Qinhuangdao Printing Factory, issued by Beijing Publishing House of Xinhua Bookstore
Sold by Xinhua Bookstores in various places
Format 880×12301/16 Printing sheet 1 Word count 20,000 words First edition in April 2002 First printing in April 2002 Print run 1-1000
Book number: 155066·1-18330
Website: bzcbs.com
Infringements will be investigated
Copyright reserved
Report hotline: (010) 68533533
Tip: This standard content only shows part of the intercepted content of the complete standard. If you need the complete standard, please go to the top to download the complete standard document for free.