Terms and definitions
Specific terms used in this guide is defined in this section.
admonition
statement used to draw the attention of the reader by labeling it with a priority tag
boilerplate (also boilerplate text)
predefined content that is automatically inserted into the output in accordance to flavor requirements
clause (also section)
logical group of content that is numerically identified in ascending order
subclause (also subsection)
clause that belongs to a top-level clause or another subclause
cross-reference
link to a location in the current document or in another external document
document attribute
key-value pair that specifies execution configuration or provides metadata at the document level
|
Note
|
A Metanorma document attribute key-value pair is implemented using the
syntax of :{key}: {value}.
|
block attribute
key-value pair that specifies execution configuration or provides metadata at the block level
|
Note
|
A Metanorma document attribute key-value pair is implemented using the
syntax of {key}={value}.
|
Metanorma flavor
Metanorma implementation that conforms to a publishing organization’s content model
|
Note
|
Conformance of content covers validity of content, the content generation process, and formatting of deliverables. |
Metanorma AsciiDoc
markup syntax for the authoring of standards based on AsciiDoc
Metanorma template
files that serve as guidance to author a specific document type in OGC flavor
NesCom
IEEE SA New Standards Committee
MEC
IEEE SA Mandatory Editorial Coordination, the editorial process for publishing draft IEEE SA deliverables for ballot
PAR
Project Authorization Request, first step to starting a WG
RevCom
IEEE SA Standards Review Committee that approves an SA standard
SC
IEEE SA Standards Committee
IEEE SASB
IEEE SA Standards Board
WG
IEEE SA Working Group
CRG
IEEE SA Comment Resolution Group
Project Number
number of IEEE SA project with an identifier starting with the character "P"
Draft Number
sequence number of IEEE SA draft with an identifier starting with the character "D"
Document Number
identifier for an IEEE SA document either with a published document number or a draft identified by a combination of the project number and draft number
IEEE standards document
standardization deliverable produced and recognized by IEEE as result of consensus
IEEE Standard
IEEE standards document with mandatory requirements
IEEE Recommended practices
IEEE standards document in which procedures and positions preferred by IEEE are presented
IEEE Guide
IEEE standards document in which alternative approaches to good practice are suggested but no clear-cut recommendations are made
These levels of requirements are often shown by the use of particular "standards verbs," i.e., "shall" for requirements, "should" for recommendations, and "may" for guidelines. (more information can be found in the IEEE SA Standards Board Operations Manual and the IEEE SA Standards Style Manual) Figuring out what level of requirement is needed helps determine what kind of document should be developed.