•
P987.6™/D3
Draft Standard for Recommended Practice for Preparing an IEEE Standards Draft

Important Notices and Disclaimers Concerning IEEE Standards Documents

IEEE Standards documents are made available for use subject to important notices and legal disclaimers. These notices and disclaimers, or a reference to this page (https://standards.ieee.org/ipr/disclaimers.html), appear in all standards and may be found under the heading “Important Notices and Disclaimers Concerning IEEE Standards Documents.”

Notice and Disclaimer of Liability Concerning the Use of IEEE Standards Documents

IEEE Standards documents are developed within the IEEE Societies and the Standards Coordinating Committees of the IEEE Standards Association (IEEE SA) Standards Board. IEEE develops its standards through an accredited consensus development process, which brings together volunteers representing varied viewpoints and interests to achieve the final product. IEEE Standards are documents developed by volunteers with scientific, academic, and industry-based expertise in technical working groups. Volunteers are not necessarily members of IEEE or IEEE SA, and participate without compensation from IEEE. While IEEE administers the process and establishes rules to promote fairness in the consensus development process, IEEE does not independently evaluate, test, or verify the accuracy of any of the information or the soundness of any judgments contained in its standards.

IEEE makes no warranties or representations concerning its standards, and expressly disclaims all warranties, express or implied, concerning this standard, including but not limited to the warranties of merchantability, fitness for a particular purpose and non-infringement. In addition, IEEE does not warrant or represent that the use of the material contained in its standards is free from patent infringement. IEEE standards documents are supplied “AS IS” and “WITH ALL FAULTS.”

Use of an IEEE standard is wholly voluntary. The existence of an IEEE Standard does not imply that there are no other ways to produce, test, measure, purchase, market, or provide other goods and services related to the scope of the IEEE standard. Furthermore, the viewpoint expressed at the time a standard is approved and issued is subject to change brought about through developments in the state of the art and comments received from users of the standard.

In publishing and making its standards available, IEEE is not suggesting or rendering professional or other services for, or on behalf of, any person or entity, nor is IEEE undertaking to perform any duty owed by any other person or entity to another. Any person utilizing any IEEE Standards document, should rely upon his or her own independent judgment in the exercise of reasonable care in any given circumstances or, as appropriate, seek the advice of a competent professional in determining the appropriateness of a given IEEE standard.

IN NO EVENT SHALL IEEE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO: THE NEED TO PROCURE SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE PUBLICATION, USE OF, OR RELIANCE UPON ANY STANDARD, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE AND REGARDLESS OF WHETHER SUCH DAMAGE WAS FORESEEABLE.

Translations

The IEEE consensus development process involves the review of documents in English only. In the event that an IEEE standard is translated, only the English version published by IEEE is the approved IEEE standard.

Official statements

A statement, written or oral, that is not processed in accordance with the IEEE SA Standards Board Operations Manual shall not be considered or inferred to be the official position of IEEE or any of its committees and shall not be considered to be, nor be relied upon as, a formal position of IEEE. At lectures, symposia, seminars, or educational courses, an individual presenting information on IEEE standards shall make it clear that the presenter’s views should be considered the personal views of that individual rather than the formal position of IEEE, IEEE SA, the Standards Committee, or the Working Group.

Comments on standards

Comments for revision of IEEE Standards documents are welcome from any interested party, regardless of membership affiliation with IEEE or IEEE SA. However, IEEE does not provide interpretations, consulting information, or advice pertaining to IEEE Standards documents.

Suggestions for changes in documents should be in the form of a proposed change of text, together with appropriate supporting comments. Since IEEE standards represent a consensus of concerned interests, it is important that any responses to comments and questions also receive the concurrence of a balance of interests. For this reason, IEEE and the members of its Societies and Standards Coordinating Committees are not able to provide an instant response to comments, or questions except in those cases where the matter has previously been addressed. For the same reason, IEEE does not respond to interpretation requests. Any person who would like to participate in evaluating comments or in revisions to an IEEE standard is welcome to join the relevant IEEE working group. You can indicate interest in a working group using the Interests tab in the Manage Profile & Interests area of the IEEE SA myProject system.1 An IEEE Account is needed to access the application.

Comments on standards should be submitted using the Contact Us form.2

Laws and regulations

Users of IEEE Standards documents should consult all applicable laws and regulations. Compliance with the provisions of any IEEE Standards document does not constitute compliance to any applicable regulatory requirements. Implementers of the standard are responsible for observing or referring to the applicable regulatory requirements. IEEE does not, by the publication of its standards, intend to urge action that is not in compliance with applicable laws, and these documents may not be construed as doing so.

Data privacy

Users of IEEE Standards documents should evaluate the standards for considerations of data privacy and data ownership in the context of assessing and using the standards in compliance with applicable laws and regulations.

Copyrights

IEEE draft and approved standards are copyrighted by IEEE under US and international copyright laws. They are made available by IEEE and are adopted for a wide variety of both public and private uses. These include both use, by reference, in laws and regulations, and use in private self-regulation, standardization, and the promotion of engineering practices and methods. By making these documents available for use and adoption by public authorities and private users, IEEE does not waive any rights in copyright to the documents.

Photocopies

Subject to payment of the appropriate licensing fees, IEEE will grant users a limited, non-exclusive license to photocopy portions of any individual standard for company or organizational internal use or individual, non-commercial use only. To arrange for payment of licensing fees, please contact Copyright Clearance Center, Customer Service, 222 Rosewood Drive, Danvers, MA 01923 USA; +1 978 750 8400; https://www.copyright.com/. Permission to photocopy portions of any individual standard for educational classroom use can also be obtained through the Copyright Clearance Center.

Updating of IEEE Standards documents

Users of IEEE Standards documents should be aware that these documents may be superseded at any time by the issuance of new editions or may be amended from time to time through the issuance of amendments, corrigenda, or errata. An official IEEE document at any point in time consists of the current edition of the document together with any amendments, corrigenda, or errata then in effect.

Every IEEE standard is subjected to review at least every 10 years. When a document is more than 10 years old and has not undergone a revision process, it is reasonable to conclude that its contents, although still of some value, do not wholly reflect the present state of the art. Users are cautioned to check to determine that they have the latest edition of any IEEE standard.

In order to determine whether a given document is the current edition and whether it has been amended through the issuance of amendments, corrigenda, or errata, visit IEEE Xplore or contact IEEE.3 For more information about the IEEE SA or IEEE’s standards development process, visit the IEEE SA Website.

Errata

Errata, if any, for all IEEE standards can be accessed on the IEEE SA Website.4 Search for standard number and year of approval to access the web page of the published standard. Errata links are located under the Additional Resources Details section. Errata are also available in IEEE Xplore. Users are encouraged to periodically check for errata.

Patents

IEEE Standards are developed in compliance with the IEEE SA Patent Policy.5

Attention is called to the possibility that implementation of this standard may require use of subject matter covered by patent rights. By publication of this standard, no position is taken by the IEEE with respect to the existence or validity of any patent rights in connection therewith. If a patent holder or patent applicant has filed a statement of assurance via an Accepted Letter of Assurance, then the statement is listed on the IEEE SA Website at https://standards.ieee.org/about/sasb/patcom/patents.html. Letters of Assurance may indicate whether the Submitter is willing or unwilling to grant licenses under patent rights without compensation or under reasonable rates, with reasonable terms and conditions that are demonstrably free of any unfair discrimination to applicants desiring to obtain such licenses.

Essential Patent Claims may exist for which a Letter of Assurance has not been received. The IEEE is not responsible for identifying Essential Patent Claims for which a license may be required, for conducting inquiries into the legal validity or scope of Patents Claims, or determining whether any licensing terms or conditions provided in connection with submission of a Letter of Assurance, if any, or in any licensing agreements are reasonable or non-discriminatory. Users of this standard are expressly advised that determination of the validity of any patent rights, and the risk of infringement of such rights, is entirely their own responsibility. Further information may be obtained from the IEEE Standards Association.

IMPORTANT NOTICE

IEEE Standards do not guarantee or ensure safety, security, health, or environmental protection, or ensure against interference with or from other devices or networks. IEEE Standards development activities consider research and information presented to the standards development group in developing any safety recommendations. Other information about safety practices, changes in technology or technology implementation, or impact by peripheral systems also may be pertinent to safety considerations during implementation of the standard. Implementers and users of IEEE Standards documents are responsible for determining and complying with all appropriate safety, security, environmental, health, and interference protection practices and all applicable laws and regulations.

Participants

At the time this draft Standard was completed, the Working Group Name Working Group had the following membership:

Arthur C. Clark, Chair

Alessandro Volta, Vice Chair

Participant1

Participant2

Participant3

Participant4

Participant5

Participant6

Participant7

Participant8

Participant9

The following members of the individual Balloting Group Name Standards Association balloting group voted on this Standard. Balloters may have voted for approval, disapproval, or abstention.

Participant1

Participant2

Participant3

Participant4

Participant5

Participant6

Participant7

Participant8

Participant9

When the IEEE SA Standards Board approved this Standard on <Date Approved>, it had the following membership:

Claude Elwood Shannon, Chair

Charles-Augustin de Coulomb, Vice Chair

SBMember1

SBMember2

SBMember3

SBMember4

SBMember5

SBMember6

SBMember7

SBMember8

SBMember9

*Member Emeritus

This document is an unapproved draft of a proposed IEEE Standard. As such, this document is subject to change. USE AT YOUR OWN RISK! IEEE copyright statements SHALL NOT BE REMOVED from draft or approved IEEE standards, or modified in any way. Because this is an unapproved draft, this document must not be utilized for any conformance/compliance purposes. Permission is hereby granted for officers from each IEEE Standards Working Group or Committee to reproduce the draft document developed by that Working Group for purposes of international standardization consideration. IEEE Standards Department must be informed of the submission for consideration prior to any reproduction for international standardization consideration (stds-ipr@ieee.org). Prior to adoption of this document, in whole or in part, by another standards development organization, permission must first be obtained from the IEEE Standards Department (stds-ipr@ieee.org). When requesting permission, IEEE Standards Department will require a copy of the standard development organization’s document highlighting the use of IEEE content. Other entities seeking permission to reproduce this document, in whole or in part, must also obtain permission from the IEEE Standards Department.

IEEE Standards Department
445 Hoes Lane
Piscataway, NJ 08854, USA


All rights reserved.

The Institute of Electrical and Electronics Engineers, Inc.
3 Park Avenue, New York, NY 10016-5997, USA

Copyright © 2020 by The Institute of Electrical and Electronics Engineers, Inc.

All rights reserved. Published <Date Approved>. Printed in the United States of America.

IEEE is a registered trademark in the U.S. Patent & Trademark Office, owned by The Institute of Electrical and Electronics Engineers, Incorporated.

PDF:ISBN 978-0-XXXX-XXXX-XSTDXXXXX
Print:ISBN 978-0-XXXX-XXXX-XSTDPDXXXXX

IEEE prohibits discrimination, harassment, and bullying.
For more information, visit https://www.ieee.org/about/corporate/governance/p9-26.html.
No part of this publication may be reproduced in any form, in an electronic retrieval system or otherwise, without the prior written permission of the publisher.


Abstract

Key discussion points covered in the draft are stated here in a few complete sentences, using passive rather than active voice. The more specific the better since the abstract often populates search engines and catalog databases.


Introduction

This introduction is not part of P987.6/D3, Draft Standard for Recommended Practice for Preparing an IEEE Standards Draft

The introduction of the frontmatter is informative. It serves to give readers context, including background, key themes, history, etc.


Acknowledgements

Permissions have been granted as follows:

Recommended Practice for Preparing an IEEE Standards Draft

1.  Overview

1.1.  Scope

The scope shall be within the technical boundaries, as determined by the balloting group, of the scope submitted on the PAR. If the standard incorporated Open Source, this should be noted in the Scpe along with a link to the Open Source of the URL.

1.2.  Purpose

The purpose shall be within the technical boundaries, as determined by the balloting group, of the purpose submitted on the PAR.

1.3.  Word usage

The word shall indicates mandatory requirements strictly to be followed in order to conform to the standard and from which no deviation is permitted (shall equals is required to).67

The word should indicates that among several possibilities one is recommended as particularly suitable, without mentioning or excluding others; or that a certain course of action is preferred but not necessarily required (should equals is recommended that).

The word may is used to indicate a course of action permissible within the limits of the standard (may equals is permitted to).

The word can is used for statements of possibility and capability, whether material, physical, or causal (can equals is able to).

2.  Normative references

The following referenced documents are indispensable for the application of this document (i.e., they must be understood and used, so each referenced document is cited in text and its relationship to this document is explained). For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments or corrigenda) applies.

IEEE Std 91,

Accredited Standards, Accredited Standards Committee C2-2012, National Electrical Safety Code® (NESC®).89

IEEE P802.21/D14, IEEE P802.21™ (Draft 14, November 2003), Draft Standard for Local and Metropolitan Area Networks — Media Independent Handover Services.10

IEEE/ASTM SI, IEEE/ASTM SI 10™, American National Standard for Metric Practice.

NFPA 70, NFPA 70, 2011 Edition, National Electrical Code® (NEC®).1112

IEEE 260.1-2004 / IEEE 260.1™-2004, IEEE Standard Letter Symbols for Units of Measurement (SI Customary Inch-Pound Units, and Certain Other Units).

ISO/IEC 27002:2013, Information technology — Security techniques — Code of practice for information security controls.

3.  Definitions, acronyms and abbreviations

3.1.  Definitions

For the purposes of this document, the following terms and definitions apply. The IEEE Standards Dictionary Online should be consulted for terms not defined in this clause.13

acceleration-insensitive drift rate: The component of…​ See also: drift rate; systematic drift rate.

code set: See: coded character set.

coded character set: A set of characters. Syn: code set.

drift rate: The slope at a stated time of…​ (adapted from ISO/IEC 9945-1:2003 [B3])

input reference axis: The direction of an axis. Syn: IRA.

NOTE—See 6.7.14

IRA: See: input reference axis.

output: (A) Data that …​(B) The process of …​

systematic drift rate: That component of drift rate that…​ (IEEE 260.1-2004)

3.2.  Acronyms and abbreviations

DER

distributed emission regeneration

DIS

distributed interactive simulation

ISDN

integrated services digital network

LAN

local area network

PDU

protocol data unit

4.  Important elements of IEEE standards drafts

4.1.  General

IEEE drafts should be created using one of the approved IEEE SA templates. The templates have built-in macro features that allow for easy tagging of each of the draft elements.15

Sources listed in the normative references clause shall also be cited in text. Explain the role and significance of each normative reference. Note that IEEE drafts may be included in the normative references clause as long as they are properly cited. See reference to IEEE P802.21 (Draft 14, November 2003) in Clause 2 of this sample.

NOTE 1—A normative reference is a document that users of the standard need to have on hand and understand in order to correctly implement the material contained in an IEEE draft.16

NOTE 2—Documents that serve as supplemental information that authors of the standard found useful when researching the material, but that do not carry the same weight as the normative references, are usually informative and therefore would belong in a bibliography (informative annex).

All IEEE standards shall use metric units as the primary units of measure. Customary equivalents may be included in the text after the metric units in parentheses. In the case of tables, separate tables for metric and customary units may be included. See National Electrical Safety Code® (NESC®) (Accredited Standards Committee C2-2012) and National Electrical Code® (NEC®) (NFPA 70, 2011 Edition) for examples. For more information on the use of metric in IEEE standards, see IEEE/ANSI SI 10. For guidance on the use of letter symbols for units of measurement, refer to IEEE Std 260.1-2004.

4.2.  Lists

Lists in a clause or subclause may be ordered or unordered.

The following is an example of a properly formatted ordered list:

  1. Name of the manufacturer

  2. Connection chart showing

    1. Full winding development

    2. Taps

  3. Self-impedance (for linear coupler transformers)

    1. Reactance

    2. Impedance

      1. For volts

      2. For amperes

The following is an example of a properly formatted unordered list:

  • Begin with a capital letter.

  • Include final punctuation for all items in the list if one item in the list is a complete sentence.

4.3.  Tables

Tables should be cited in text and the significance of the tables explained. Table titles are positioned above the tables. Table 1 shows the nomenclature of a properly formatted table.

Table 1—Table formatting

Column headingColumn headingColumn headinga
Column headingColumn heading

Line heading

Subheading

Subheading

Tabulated data (individual positions within the body of the table are called cells)

Line heading

NOTE 1—This table is provided as an example. The structure of actual tables may vary depending on the data being displayed.

NOTE 2—Use 0.75 Xd for hydrogenerators without amortisseur windings.

a  Table footnotes are considered to be a normative part of the document.

Column headings are in bold and centered. If a table extends beyond one page, carry the title of the table over to each subsequent page with “(continued)” after the title. Table notes are informative; table footnotes are normative.

The following is an example of an informal table. Note that there is no title or table number. Use these sparingly. It is preferred that all tables are numbered and titled.

Cable typeRated voltage (kV)

High pressure

69–161

Low pressure

Gas-filled

10–29

30–46

Low and medium pressure

Liquid-filled

15–161

230

4.4.  Figures

Figures should be cited in text and the significance of the figures explained. Figure titles are positioned below the figures themselves. Figures can be created using text or graphics software. Figure 1 and Figure 2 show properly formatted figures.

Figure 1—Typographical specifications for figure title

Figure 2-1—vibration test

Figure 2-2—shock test

Figure 2—A sample of figure presentation

NOTE—Notes to figures are formatted between the graphic and the figure caption.

4.5.  Equations

Equations should be cited in text and the significance of each equation explained. The equation number should be right-aligned. See Equation (1).

Y x = Y 0 exp − x − x 0 2 / 2 f 2   (1)

Y x

is the amplitude of the Gaussian function at channel x

Y 0

is the height of the Gaussian at the centroid channel

x

is the channel number

x 0

is the centroid of the Gaussian

f

is the width of the Gaussian


Annex A
(informative)
Sample bibliography

Bibliographical references are resources that provide additional or helpful material but do not need to be understood or used to implement this standard. Reference to these resources is made for informational use only.

[B1]  IEEE Std XXX™-YEAR, IEEE Standard for Something Industry Needs.

[B2]  Name of Book Title in Italics. City of Publication, State: Name of Publisher, Year of Publication. First and Last Page of Reference.

[B3]  ISO/IEC 9945-1:2003, Information technology — Portable Operating System Interface (POSIX) — Part 1: Base Definitions.


Annex B
(normative)
Structure of a sample annex

B.1.  Overview

B.1.1.  Title

Every annex shall be given a title and shall be designated either a normative or an informative annex. Notice that the numbering now contains the annex letter. See Equation (B.1):

Y x = Y 0 exp − x − x 0 2 / 2 f 2   (B.1)

Y x

is the amplitude of the Gaussian function at channel x

Y 0

is the height of the Gaussian at the centroid channel

x

is the channel number

x 0

is the centroid of the Gaussian

f

is the width of the Gaussian

B.1.2.  Clause and subclause organization

The material in an annex should be organized into clauses and subclauses just like the body text. There should be at least two subclauses in any subdivision so that if there is one second-level header, there should be at a minimum one other one.

B.2.  Material in annexes

Tables, figures, equations, lists, etc., in an annex are formatted like they would be in the body of the text except that

  • Tables are numbered according to the annex letter (see Table B.1).

  • Figures are labeled according to the annex letter (see Figure B.1).

Table B.1—Sample table in an annex

Column headingColumn headingColumn heading
Column headingColumn heading

Line heading

Subheading

Subheading

Tabulated data (individual positions within the body of the table are called cells)

Line heading

Figure B.1—Sample figure in an annex