GEIA-OP-0002-2002 Style Manual for Standards and Other Publications of GEIA (Formerly TechAmerica GEIA-OP-0002)《GEIA标准和其他出版物风格手册》.pdf

《GEIA-OP-0002-2002 Style Manual for Standards and Other Publications of GEIA (Formerly TechAmerica GEIA-OP-0002)《GEIA标准和其他出版物风格手册》.pdf》由会员分享，可在线阅读，更多相关《GEIA-OP-0002-2002 Style Manual for Standards and Other Publications of GEIA (Formerly TechAmerica GEIA-OP-0002)《GEIA标准和其他出版物风格手册》.pdf（81页珍藏版）》请在麦多课文档分享上搜索。

1、GEIA ENGINEERING BULLETIN Style Manual for Standards and Other Publications of GEIA GEIA-OP-0002 February 2002 GOVERNMENT ELECTRONICS AND INFORMATION TECHNOLOGY ASSOCIATION Copyright Government Electronics general style; and style for special elements such as equations, tables, and figures. They wil

2、l help ensure that a standard is well organized and that it is consistent in style and presentation within itself and with other standards published by GEIA. Formulating committees and working groups should comply with the requirements set forth in this manual to make the product of the committees w

3、ork available for application in as short a time as possible. The GEIA Standards and Technology Department will use this manual to resolve non-technical comments received as a result of public review of proposed standards. This manual is based on widely accepted usage. Its sources include the IEC/IS

4、O Directives, Part 3 Drafting and Presentation of International Standards, 1997 (see annex A for differences); American National Standards Institute (ANSI)-approved consensus standards on unit and letter symbols, abbreviations, drafting, and publishing practices; Webster !s Third New International D

5、ictionary, Unabridged; and Merriam- Websters Collegiate Dictionary, Tenth Edition. Annexes A, B, C, F, and K through N are informative; annexes D, E, G, H, and J are normative. This release of this style manual incorporates the contents of EIA EP-7-C. The majority of the text remains unchanged. The

6、material contained in this publication was formulated under the cognizance of the GEIA Standards and Technology Department. Introduction It is recognized that amongst standards writers many different tools are used for the drafting of standards, and that these tools will not necessarily permit the s

7、ame options for the presentation of text elements. Therefore, wherever possible, optional presentations have been allowed for in these rules e.g., it is permitted to precede the items in an unordered list by dashes or bullets (see 5.2.6). However, for such cases it should be noted that the GEIA Stan

8、dards and Technology Department reserves the right to apply only one presentation in published standards. 1 Copyright Government Electronics e.g., instructions are expressed in the imperative mood, recommendations by the use of the auxiliary “should”, and requirements by the use of the auxiliary “sh

9、all”. ISO/IEC Guide 2; 1996, definition 7.21 3.6.1 statement: A provision that conveys information. 3 Copyright Government Electronics 1996, definition 7.51 3.7 state of the art: The developed stage of technical capability at a given time as regards products, processes, and services, based on the re

10、levant consolidated findings of science, technology, and experience . ISO/IEC Guide 2; 1996, definition 1.41 4 Copyright Government Electronics identical wording shall be used to express identical provisions. The same term shall be used throughout each standard or series of standards to designate a

11、given concept. The use of an alternative term (synonym) for a concept already defined shall be avoided. Insofar as possible (see G.1.4.8), only one meaning shall be attributed to each term chosen. These requirements are particularly important, not only to ensure comprehension of the standard but als

12、o to derive the maximum benefit available through automated text processing techniques and computer- aided translation. 4.3 Consistency of standards In order to achieve the aim of consistency within the complete body of standards, the text of every standard shall be in accordance with the relevant p

13、rovisions of existing basic GEIA, ANSI, and international standards. This requirement relates particularly to a) standardized terminology, b) principles and methods of terminology, c) quantities, units, and their symbols, d) abbreviations, e) bibliographic references, f, technical drawin s, and g) g

14、raphical symbo B s. In addition, the relevant technical provisions of general GEIA, ANSI, and international standards shall be followed. A list of basic standards is given in annex C. 4.4 Implementation The content of a GEIA standard shall be constructed in such a way as to permit its direct applica

15、tion and to facilitate its adoption with minimum change as an American national standard or international standard. 4.5 Planning In order to ensure the timely publication of a standard, or of a series of associated standards, a list of all aspects to be covered shall be defined before detailed draft

16、ing begins so that scope(s), structure(s), and interrelationships can be established. These rules for the drafting and presentation of standards shall be applied from the very beginning of the work and through all subsequent stages to avoid delay at any stage. 5 Copyright Government Electronics or b

17、) by their required or optional presence (see 3.6 and 3.7). 8 Copyright Government Electronics upright type = normative element; italic type = informative element. Informative annexes may not contain normative elements unless these elements constitute optional provisions. For example, a test method

18、that is optional may contain provisions. Notes integrated into the text (see 6.5.1) may be part of any element except the cover, the title, and footnotes. 9 Copyright Government Electronics e.g., clauses in section 2 would be numbered 2.1, 2.2,2.3, etc. Each section shall begin at the top of a right

19、-hand page. The title shall be centered and laid out as in the following example: SECTION 1: SYMBOLS FOR QUANTITIES AND THEIR UNITS 5.2.3 Clauses A clause is the basic component in the subdivision of the text of a standard. The clauses in each standard or part shall be numbered with arabic numerals,

20、 beginning with 1 for the “Scope” clause. The numbering shall be continuous up to but excluding any annexes (see 5.2.7). For the numbering of clauses within sections, see 5.2.2. 10 Copyright Government Electronics e.g., if 10.1 has a title, 10.2 shall also have a title. In the absence of titles, key

21、 terms or phrases (composed in distinctive type) appearing at the beginning of the text of the sub-clause may be used to call attention to the subject matter dealt with. For examples, see 6.6.7.1 through 6.6.7.6. Such terms or phrases shall not be listed in the table of contents. 5.2.5 Paragraphs A

22、paragraph is an unnumbered subdivision of a clause or sub-clause. For example 5.2.4 comprises three paragraphs. ISO/IEC Directive 3 prohibits the inclusion of text in any but the lowest-level sub-clauses of international standards. This prohibition is not maintained by this manual for GEIA publicati

23、ons; however, the practice of including text in higher-level paragraphs is not recommended because of the ambiguity in references that is likely to result. For example, if text is included in clause 5 preceding 5.1, a reference to clause 5 that is intended to include any of its sub-clauses must be w

24、ritten as “clause 5 (including its sub-clauses)” or “clause 5 through sub-clause 5.1.3” or whatever applies. Similarly, the text in clause 5 that precedes its sub-clauses may be referred to as “the text in clause 5 that precedes 5.1”. To simplify these references, it would be necessary to renumber t

25、he text as 5.1 (possibly titling it, e.g., “General”) and then renumber existing 5.1 and subsequent sub-clauses, or to move the text elsewhere. 5.2.6 Lists When the introduction to a list could stand alone as a sentence and the items in the list are not sentences, the introduction shall be followed

26、by a colon with the items separated by semicolons (see example 1). When the introduction to a list could stand alone as a sentence and the items in the list could also stand alone as sentences, (1) the introduction and each item shall be written as sentences (see example 2) or (2) the introduction s

27、hall be followed by a colon with the items separated by semicolons (see example 2, first list item). When the introduction to a list cannot stand alone as a sentence, it will generally be followed by no punctuation (as in example 3, below), or by a comma when called for (as in 6.4.2.3), with the lis

28、ted items separated by commas. 11 Copyright Government Electronics b) apparatus having a power consumption not exceeding 50 W, measured two minutes after the application of any of the fault conditions; c) apparatus intended for continuous operation. EXAMPLE 2 The following requirements apply to the

29、preparation and submission of the reports. a) The reports shall be submitted by the required dates unless arrangements are agreed upon for later submission: 1) reports on failures occurring in January through June are due by the following first day of 2) reports on failures occurring in July through

30、 December are due by the following first day of b) The reports shall be certified by the manager of the organization that performed the tests of the c) The reports shall be organized as specified in annex Z. This means that reports organized under August; February. failed parts. previous rules will

31、no longer be acceptable. EXAMPLE 3 Vibrations in the apparatus may be caused by a) unbalance in the rotating elements, b) slight deformation in the frame, c) the roller bearings, and d) aerodynamic loads. Key terms or phrases may be composed in distinctive type to call attention to the subject matte

32、r dealt with in the various list items (e.g., see example 2 above and 6.1.1). Such terms or phrases shall not be listed in the table of contents. If it is necessary that these terms or phrases be listed in the table of contents, they shall be presented as sub-clause titles (see 5.2.4) rather than as

33、 list items. 5.2.7 Annexes For the description of the two types of annexes, see 6.3.8 and 6.4.1. Annexes shall appear in the order in which they are cited in the text. Each annex shall be designated by a heading comprising the word “Annex” followed by a capital letter designating its serial order, b

34、eginning with “A” but omitting “I” and “O”, e.g., “Annex A”. The annex heading shall be followed by the indication “(normative)” or “(informative)”, and by the title, each on a separate line. Numbers given to the clauses, sub-clauses, tables, figures, and equations of an annex shall be preceded by t

35、he letter designated to that annex followed by a period. The numbering shall start afresh with each annex. A single annex shall be designated “Annex A”. EXAMPLE Clauses in annex A are designated “A. l”, “A.2”, “A.3”, etc. 5.2.8 Bibliography A bibliography, if present, shall appear after the last ann

36、ex. For the drafting rules, see 6.4.2. 12 Copyright Government Electronics b) a main element (required) indicating the principal subject treated within that general field; c) a complementary element (optional) indicating the particular aspect of the principal subject or giving details that distingui

37、sh the standard from other standards or from other parts of the same standard. The title shall appear on the front cover and at the top of the page following the inside front cover. The rules in annex H for the drafting of titles have governed the titling of international standards for many years an

38、d shall be applied to all new GEIA publications. 6.1.2 Notice and statement outlining similarities with non-GEIA standards The GEIA Standards and Technology Department will provide the official notice that appears on the inside front cover of all published GEIA documents. Other information may also

39、be included. During development of a standard, the formulating committee or working group shall conduct a review and compare the standard with any related non-GEIA standards such as those from the International Electrotechmcal Commission (IEC), International Organization for Standardization (ISO), E

40、lectronic Industries Association of Japan (EIAJ), etc. GEIA standards should agree technically with these non- GEIA standards, especially international standards, unless there are valid technical reasons why this is not possible. Once this review has been completed, the chair should select the one p

41、aragraph of the following five that most nearly expresses the extent to which the standard agrees with a similar non-GEIA standard. The wording may be modified if necessary to achieve an accurate statement. This information is useful to U.S. users of GEIA standards as well as to the cognizant U.S. T

42、echnical Advisory Group for international standards. The paragraph selected will appear on the inside front cover of the completed GEIA standard following the official notice. a) “This standard is based upon the major technical content of International Electrotechnical Commission, International Orga

43、nization for Standardization, or Electronic Industries Association of Japan standard number, title, date. It conforms in all essential respects with this IEC, ISO, or EIAJ standard.” b) “This standard contains the major technical contents of International Electrotechnical Commission, International O

44、rganization for Standardization, or Electronic Industries Association of Japan standard number, title, date. It differs from IEC, ISO, or EIAJ standard number in certain important respects, as given in annex A hereto. These differences have been called to the attention of the U.S. National Committee

45、 of the IEC or IS01 Technical Committee number, title, date, and resolution of these differences will be sought in future meetings of TC number or GEIA number.” 14 Copyright Government Electronics b) the designation and name of the committee that prepared the standard; c) information regarding the a

46、pproval of the standard; d) an indication of any other organization that has contributed to the preparation of the standard; e) a statement that the standard cancels and replaces other documents in whole or in part; f, a statement of significant technical changes from the previous edition of the sta

47、ndard; g) the relationship of the standard to other standards or other documents; h) a statement as to which annexes are normative and which are informative. 6.1.5 Introduction The introduction is an optional preliminary element that may be used to give specific information or commentary about the t

48、echnical content of the standard and about the reasons prompting its preparation. It shall not contain requirements. The introduction shall not be numbered unless there is a need to create numbered subdivisions. In this case, it shall be numbered O with sub-clauses numbered 0.1, 0.2, etc. Any number

49、ed figure, table, displayed formula, or footnote shall be numbered normally beginning with 1. 15 Copyright Government Electronics see annex H. EXAMPLE 1 EIA/JEDEC JESD22-AllO-A, Highly accelerated temperature and humidity stress test (HAST), April 1997. EXAMPLE 2 EIA/JEDEC JEP95 - (all parts), JEDEC registered and standard outlines for solid state and related products. 16 Copyright Government Electronics b) documents to which only informative reference is made; or c) documents that have merely served as references in the preparation of the standard. Such do