Typical sections in IEEE
General
The easiest way to ensure that you are following the document structure that IEEE demands, is to use a Metanorma template.
If you author a document type that doesn’t have a template, check a sample document for better understanding how to structure that document.
Typically, an IEEE SA document contains the following content order:
Preface segments
Abstract
The abstract of the document is marked up as a clause with the style attribute
[abstract].
[abstract]
== Abstract
This standard is intended to promote and facilitate interoperability
between components of an automatic test system (e.g., between test
executive and diagnostic reasoner) where test results need to be shared.Keywords
The keywords of the document are given as the comma-delimited :keywords:
document attribute (see Document attributes).
Introduction
The introduction of the document is marked up as a clause with the title "Introduction". The initial boxed text, "This introduction is not part of P{designation}/D{draft_number}, Draft {document-type} for {par-title}" is automatically generated and populated by Metanorma. Do not provide it.
Acknowledgements
If the document refers to any externally sourced content that require permission or licensing acknowledgements, they are entered as a section with the title "Acknowledgements".
The "Acknowledgements" section shall appear immediately after the "Introduction", in accordance with the IEEE SA Style Manual (2021).
|
Note
|
The placement of the "Acknowledgements" section differs in legacy documents, some IEEE SA standards places it immediately before the "Introduction". |
== Acknowledgements
<<table2>> of this standard is printed with permission from BBN Corporation.Automatic generated content
The templated material ("boilerplate") of the document front matter is all automatically provided by Metanorma:
-
Front page: Copyright statement, license statement
-
Second page: Contact information, ISBNs
-
Important Notices and Disclaimers Concerning IEEE Standards Documents
-
Participants statement (the membership of the various committees is provided in a Participants clause)
-
The note before the overview in amendments, indicating how formatting is to be interpreted
Terms and definitions
The terms and definitions is used to define important terms and cite them throughout the standard.
Learn how to enter terms and definitions.
References
The references section contains normative references, it is considered a “bibliography” section.
Learn how to enter bibliographic entries.
|
Note
|
In IEEE there are two “bibliography” sections. The “References” section for normative references, and the “Bibliography” section which is for informative references. |
Content sections
After the sections above, any number of content sections can be added.
Annex sections
General
Annex sections are declared by prepending the [appendix] tag above the section
declaration.
Annexes can be added as necessary.
An annex can either be normative or informative. By default an annex is marked informative.
In order to declare a normative annex, use the obligation attribute in
the following manner: [appendix,obligation=normative]
// Without declaration, an annex is informative.
[appendix]
== Informative annex title
...
// A normative annex.
[appendix,obligation=normative]
== Normative annex title
...
// A informative annex with explicit declaration
[appendix,obligation=informative]
== Informative annex title
...Annex clauses are placed after all content sections, right before the bibliography section.
Glossary
IEEE SA documents support an extra definitions section that represents informative terms, as a "Glossary" section in the annex.
It can be encoded as follows:
[appendix]
== Glossary
=== My term
My definition
...The usage and syntax of this section is identical to that of Terms and definitions. Please refer to the terms and definitions syntax on how to write out the terms in the Glossary.