| |
| |
Explanatory statements may be used in the text for emphasis or to offer informative suggestions about the technical content of the standard. These notes provide additional information to assist the reader with a particular passage and shall not include mandatory requirements. A note in the text is not an official part of the approved standard, therefore important information on safety, health, or the environment shall not be included. A note should follow that paragraph to which it belongs, and shall be set apart from the text by introducing the statement with the capitalized word “NOTE—”. Within each subclause, multiple notes in sequence should be numbered “NOTE 1—”, “NOTE 2—”, etc. (See Annex B for examples.)
“Note that” is normative and is translated to mean “pay special attention to.” “Note that” is usually part of a paragraph while “NOTE—” is set apart as its own paragraph.
Footnotes in text may be included in a standard only for information, clarification, and/or aid applicable to the use of the standard. Mandatory requirements shall not be included in text footnotes because these footnotes are not officially part of the standard. Note that footnotes to tables and figures follow different rules (see 15.5 and 16.3).
Footnotes in the front matter should be indicated separately. Front-matter footnotes should be indicated with lowercase letters.
Footnotes in the body and annexes should be numbered consecutively using Arabic numerals. When there are footnotes within tables and figures, they should be lettered. If a footnote is cited more than once, each additional citation should refer back to its first mention as follows:
Examples may be used as illustrations of aid understanding of the standard. Examples are not an official part of the standard; therefore, requirements shall not be included in the text of the example. (See 18.4 and Clause 19 for illustrations of examples.)
Warnings call attention to the use of materials, processes, methods, procedures, or limits that have to be followed precisely to avoid injury or death. Cautions call attention to methods and procedures that have to be followed to avoid damage to equipment. A warning is more important than a caution. If both are to be written for the same related clause or subclause, the warning shall precede the caution.
Warnings and cautions should start with a clear instruction, followed with a short explanation (if necessary). If the warning or caution is of a general nature (and is applicable throughout the text), it should be placed at the start of the text. This avoids the necessity of repeating the same warning or caution frequently throughout the text. Warnings and cautions shall not be placed in informative text or notes.
Complete and current information for bibliographic entries should be supplied by the working group. The bibliography always should be an informative lettered annex that appears as either the first or last annex of the standard (if an index is included, the annexes would precede the index). (See Annex A for an example bibliography).
If bibliographic items are cited in text, tables, figures, or notes, the citation should be placed at the point where reference is made to them. If the item is a standard, the designation (e.g., IEEE Std 1226.6-1996) and bibliographical reference number (e.g., [B4]) should be cited. If the reference is to an article, book, or other type of publication included in the bibliography, the title or author of the publication and the bibliographic reference number should be cited.
The bibliography should be ordered alphanumerically, without respect to the type of publication being cited.
Standards listed shall include designation and title.
[B1] ASME BPVC-I-2004, Boiler and Pressure Vessel Code, Section 1—Power Boilers.
[B2] Code of Federal Regulations Title 29 Part 1210 Section 354 (29CFR1210.354), Health and Safety Standards—Head injury.
[B3] ISO/IEC 7498-4, Information processing systems—Open Systems Interconnection—Basic Reference Model—Part 4: Management framework.
Articles listed shall include the following information in the order shown:
[B1] Boggs, S. A. and Fujimoto, N., “Techniques and instrumentation for measurement of transients in gas-insulated switchgear,” IEEE Transactions on Electrical Installation, vol. ET-19, no. 2, pp. 87–92, Apr. 1984.
Books listed shall include the following information in the order shown:
[B26] Peck, R. B., Hanson, W. E., and Thornburn, T. H., Foundation Engineering, 2d ed. New York: McGraw-Hill, 1972, pp. 230–292.
NOTE—Consult The Chicago Manual of Style [B1] for more information on how to list books and periodicals.
[B10] Henry, S., and Selig, C., “Predicting source-code complexity at the design stage,” IEEE Software, vol. 7, no. 2, pp. 36–44, Mar. 1990.
This paper states that the use of design metrics allows for determination of the quality of source code by evaluating design specifications before coding, causing a shortened development life cycle.
[B6] Dale, S. J., “Performance of a technical and economic feasibility study of an HVDC compressed gas-insulated transmission line,” Westinghouse Electric Corporation, Trafford, PA, Final Report, Dec. 1983.
[B3] Cookson, A. H., and Pedersen, B. O., “Thermal measurements in a 1200 kV compressed gas insulated transmission line,” Seventh IEEE Power Engineering Society Transmission and Distribution Conference and Exposition, Atlanta, GA, pp. 163–167, Apr. 1979.
[B2] Cookson, A. H., “Particle Trap for Compressed Gas Insulated Transmission Systems,” U.S. Patent no. 4554399, Nov. 1985.
[B3] EPRI EL-2040, Project 1352–1, Probability-Based Design of Wood Transmission Structures— Volume 3: User’s Manual, POLEDA-80—POLE Design and Analysis, Final Report, Goodman, J., Vanderbilt, M., Criswell, M., and Bodig, J.
[B5] Diessner, A., “Studies on Compressed Gas Insulation.” Master’s thesis, Stanford University, 1969.
[B6] Hazel, R. L., “DC Breakdown and Anode Corona Characteristics of Sphere and Rod-Plane Gaps Insulated With Compressed Sulphur Hexafluoride.” Ph.D. diss., University of Windsor, 1974.
Working groups with access to the electronic publishing tools used by the IEEE Standards Department should be aware that source files of text and graphics are usually available for electronic revision. Therefore, those who are working on a revision should contact an IEEE Standards project editor.
Changes to standards can be implemented by issuing amendments and corrigenda.
An amendment is a document that contains new material to be incorporated into an existing IEEE standard and that may contain technical corrections to that standard as well. A corrigendum is a document that contains only technical corrections to an existing IEEE standard.
Amendments and corrigenda are balloted documents that give explicit instructions on how to change the text in an existing base standard or an existing amendment. The requirements for amendments and corrigenda are the same as for standards. However, these documents also contain editing instructions for each change. The editing instructions are important because the user should understand how the changes affect the base standard and because these documents are incorporated into the base standard sometime in the future.
Both types of documents have the same format. The following text shall appear at the beginning of either an amendment or a corrigendum:
NOTE—The editing instructions contained in this <amendment/corrigendum> define how to merge the material contained herein into the existing base standard and its amendments to form the comprehensive standard.
The editing instructions are shown in bold italic. Four editing instructions are used: change, delete, insert, and replace. Change is used to make corrections in existing text or tables. The editing instruction specifies the location of the change and describes what is being changed by using
strikethrough(to remove old material) and underscore (to add new material). Delete removes existing material. Insert adds new material without disturbing the existing material. Insertions may require renumbering. If so, renumbering instructions are given in the editing instruction. Replace is used to make changes in figures or equations by removing the existing figure or equation and replacing it with a new one. Editing instructions, change markings, and this NOTE will not be carried over into future editions because the changes will be incorporated into the base standard.
Editing instructions and text indicating the changes to the base document follow the NOTE. Change bars shall not be included. (See Annex C for an example of an amendment/corrigendum.) Only material being affected by the changes of the amendment/corrigendum shall be included with the appropriate clause/ subclause headings.
Amendments and corrigenda should follow the clause numbering outlined in Clause 11. However, if text is inserted between existing consecutive clauses or subclauses, an additional letter may be included in the heads (e.g., if clauses are inserted between Clause 4 and Clause 5, the new clauses would be labeled Clause 4A, Clause 4B, Clause 4C). This would also apply to subclauses (e.g., subclauses inserted between 4.1.3 and 4.1.4 would be labeled 4.1.3a, 4.1.3b, 4.1.3c). Subdivisions of inserted subclauses would follow the numbering outlined in Clause 11 (e.g., 4.1.3a.1, 4.1.3a.2, 4.1.3a.3). This numbering may be more appropriate for amendments with extensive changes that would affect numbering throughout the base standard (so it would be difficult to outline all the numbering changes that would occur), or for amendments to standards where exact references to clauses, figures, equations, and tables are required.
Additional amendments to a base standard may insert text between already amended clauses or subclauses. In these cases, numbering of clauses may become very complex. An IEEE Standards project editor can assist with complex numbering formats. Working groups should consider a revision of the document in these instances. For tables and figures in amendments and corrigenda, clause or subclause numbering should follow the numbering outlined in 15.3 and 16.2. However, if an amendment or corrigenda inserts a table between consecutive tables, or a figure between consecutive figures, the addition of a letter may be used.
Exceptions may be made for numbering established in previously published amendments. Exceptions shall only be valid until a revision occurs, after which the numbering described in Clause 11 will be implemented. Table 5 shows appropriate numbering formats that may be used for amendments and corrigenda. (See Annex C for examples of amendment numbering.)
Amendments submitted for ballot shall clearly indicate the changes to the existing standard. Editorial instructions shall clearly outline how the changes should be implemented in the base standard, as modified by all previously approved amendments or corrigenda. The instructions shall not require interpretation by the IEEE Standards project editor, by the balloter, or by any user. Therefore, the placement of the changes, as well as any renumbering that is required, shall be delineated in a manner that does not result in ambiguities.
Editorial instructions shall precede all changes, and should begin with one of the four types of editing instructions, which are formatted in bold italic: change, insert, delete, and for figures or equations, replace. Change shall be used when text or tables are being modified, therefore strikethrough (for deletions) and underscore (for insertions) should be indicated. Insert shall be used to include new text, equations, tables, or figures in the standard. Delete shall be used to remove existing text, equations, tables, or figures without exchanging the information (i.e., it is not permissible to delete a paragraph and insert a new one rather than showin g the changes in the paragraph using the change instruction). Replace shall be used only for figures and equations by removing the existing figure or equation and replacing it with a new one. (See Annex C for examples of editorial instructions in amendments or corrigenda.)
Additional tips for creating amendments and corrigenda are available from the IEEE Standards World Web site <http://standards.ieee.org/guides/style/index.html>. IEEE Standards project editors are also available for questions that arise while preparing these documents.
The greater the number of amendments or corrigenda associated with a standard, the more complex the editing instructions become for all subsequent amendments and corrigenda. If three amendments to a standard exist however, working groups are encouraged to revise the standard rather than develop an additional amendment (see 8.1.2 and 9.2 of the IEEE-SA Standards Board Operations Manual [B6] for additional information and exceptions).
For an amendment, only the changes and the respective editorial instructions
go before balloters. For revisions, the entire document is open for comments.
Table 5 lists examples of numbering schemes for amended clauses included in
amendments and corrigenda.
Working groups preparing IEEE standards may wish to submit their standards to ISO, IEC, or ITU. The IEEE Standards Department offers guidance to working groups on preparation of their documents from both a stylistic and technical perspective.
If there is an interest in such submissions, working group chairs should contact an IEEE Standards project editor early in the development cycle of their standards. Issues involving coordination and/or cooperation with committees from ISO, IEC, or ITU should be directed to your Standards Staff Liaison. The requirements contained in the IEEE copyright notice for draft standards shall be followed (see 4.2.2).
The IEEE Standards Department has harmonized its style with the principles of ISO/IEC style, as stated in the ISO/IEC Directives Part 2 [B8]. However, the IEEE has made some exceptions to the ISO/IEC directives. The following guidelines may prove helpful in understanding these exceptions:
a) The IEEE will continue to designate and to title standards according to 4.2.3 and 9.1. If a working group intends that its standard should one day be an ISO/IEC standard, the chair should consult with IEEE staff when preparing the PAR so that the title incorporates ISO/IEC considerations. IEEE Standards project editors to clarify their actions with regard to this. b) While ISO and IEC do not credit individual members of their developing committees, the IEEE will continue to credit its working group and the voting members of the balloting group in the informative front matter of standards. Groups developing ISO/IEC standards should consult with c) ISO and IEC mandate the use of a foreword in their documents (in addition to the IEEE introduction). The foreword gives the development history of the document, including a statement of significant technical changes from any previous edition of the document, and may include:
— A list of any other international organization that has contributed to the preparation of the document; — A statement that the document cancels and replaces other documents in whole or in part; — The relationship of the document to other documents; — In IEC, an indication of the next maintenance result date. d) The IEEE shall continue to use the period as a decimal sign rather than the comma. e) Format of definitions and notes in IEEE draft standards will comply with 10.5 and 18.1. f) Since American English is acceptable internationally, the IEEE will continue to use American English grammar and spelling in its standards. This should pose no difficulty to groups developing international standards. In cases where British spelling is used in an internationally recognized term (e.g., “Fibre Distributed Data Interface”), that spelling may be retained. h) Working groups that intend to submit their drafts for review by JTC1 should ensure that any included normative references meet the JTC1 requirements for references. ISO/IEC requires that referenced standards that are not ISO or IEC standards be accompanied by appropriate documentation. g) ISO and IEC use lowercase letters and periods in abbreviated terms consisting of the initial letters of words (e.g., “a.c.” for “alternating current ”); however, the IEEE style of not using periods in abbreviations and acronyms is acceptable.
The following information should be useful for those who are developing standards that will be forwarded to ISO or IEC. IEEE Standards project editors may be consulted to help determine the best options for formatting documents that are intended for adoption by ISO or IEC.
a) Stylistic changes may be considered technical changes by ISO or IEC (e.g., capitalization of “standard” to “Standard” when self-referencing the document). These stylistic requirements should be determined and then communicated to IEEE project editors as a part of the submission of the draft standard to RevCom for final approval by the IEEE-SA Standards Board. b) The use of trade names, product names, and trademarks within the standard should be avoided. c) All subclauses within a clause shall be titled. d) Families of documents should be similar in organization and in their use of definitions. e) The foreword should contain any mention of closely related standards, changes from any previous editions of the standard, and the structure of the normative and informative parts of the standard. Historical or specific technical commentary about the preparation of the standard should be included in the introduction. f) All tables and figures should be titled and numbered consecutively (except as noted in 15.2 and 16.2). Numbering of figures within clauses is not allowed (e.g., Figure 1-1, Figure 1-2, Figure 1-3). g) Ranges should repeat the unit (i.e., 115 V to 125 V, not 115 –125 V). h) Photographs should be avoided as artwork; if possible, concepts should be depicted as drawings rather than photographs. i) Cross-references using page citations are not permitted. j) The bibliography is the last annex (i.e., there is no option to place the bibliography as the first annex).
Working groups interested in the adoption of international standards shall follow the procedure for submission of independently developed documents outlined in 5.2. Some international organizations have established guidelines for adoption that will need to be followed (e.g., international organizations may have restrictions against adopting International Standards as recommended practices or guides; information on regional or national adoption of ISO and IEC standards are given in ISO/IEC Guide 21 [B9]). Working groups will need to notify the IEEE Standards Activities Department (stds.ipr@ieee.org) prior to initiating the adoption process.
Back to table of contents 
Go to next clause
 |
|||
| |||
