Authoring guide for IEEE SA documents

Scope

This document provides details for an IEEE SA author on how to create IEEE SA deliverables using Metanorma.

Note	Please use the latest version of Metanorma with this guide. Some guidance may not be compatible with older versions. Details on how to install the latest version of Metanorma.

Normative references

• Metanorma AsciiDoc

• IEEE SA Training and Resources for Drafting Standards

• 2021 IEEE SA Standards Style Manual (PDF)

Contents

This guide assumes familiarity with the normative references listed above.

The following sections provide a step-by-step guide allowing you to create a deliverable compliant with IEEE SA requirements and guidance.

Consider going through them step by step.

1. Terms used in this guide

2. Deliverable development process

3. Introduction to Metanorma AsciiDoc

4. Creating a new document

5. Encoding document metadata

6. Sections required

7. Block text syntax

8. Text formatting syntax

9. Entering cross-references

10. Adding terms and definitions

11. Adding bibliographic entries

Bibliography

• IEEE SA Draft Review (Mandatory Editorial Coordination, MEC) Checklist (PDF)