STEPlib, drafting standards rules

This page starts to describe the drafting rules

Todo

text for this section

ISO/IEC Directives, Part 2, current

Todo

all of this section

See the IDP2 home page for info.

Do not use must instead of shall (See ISO/IEC Direcives, Part 2, 2021, Clause 7)

Do not use shall, should or may in NOTES and EXAMPLES (See ISO/IEC Directives, Part 2, 2021, Clause 24 and 25)

STEPlib-NG specific

References to numbered elements (Figure, Table, Formula ...)

In the documentation use a <systemoutput /> tag instead of “below, above, following”.

EXAMPLE The Figure <systemoutput>Simplified overview of the AP242 Annotated Model presentation</systemoutput> provides an overview of the capability.

Note

Title should be unique in the model.

References to bibliographic unnumbered document

In the documentation use bibitem=”reference” (where reference is the <id=”“> of the document in the master data. (can be normref.xml, biblio.xml or commonAdditionalRefs.xml)

EXAMPLE This annex provides the source files associated to this document, including the Domain model XMI in Canonical XMI bibitem=”ISO/IEC 19509”.

Note

add the bibitem=”” only if the text cites an unnumbered document. See ISO House Style https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-referencing

Section author: Veronique Dubillot [Boost Conseil]