Principles-for-drafting-ETSI-deliverables
Introduction
This guide provides step-by-step instructions to support ETSI rapporteurs and experts in drafting ETSI deliverables. It complements the ETSI skeletons, which are pre-built deliverables, already laid out as required and containing essential titles and text blocks. It is the essential foundation for your working document that can be used for any of the Microsoft Word® versions.
For the drafting of ETSI deliverables it is recommended to download the following documents and tools from edithelp! website:
- The appropriate ETSI skeleton.
- The most recent publication of the ETSI Drafting Rules (EDRs).
- The template and toolbar of ETSI styles.
Table of contents and List of figures and/or tables
Contents
The table of contents named "Contents" is a required element, automatically generated and already included on page 3 of ETSI skeletons.
For the title use TT style. For the table itself use the field { TOC \o \w "1-9" }.
If it is needed to unlock the table of contents:
Select the entire table of contents, click simultaneously: Ctrl + Shift + F11.
To update the table of contents:
Press on F9.
To lock the Table of Contents:
Select the table of contents and then click simultaneously: Ctrl + F11.
List of figures and/or tables
"List of figures" and/or "List of tables" are optional unnumbered informative elements. They can be automatically generated using the field indicated below (one or the other or both). If used they shall appear after the table of contents.
For the title use TT style .
For the list of figures use the field {TOC \t "TF" \c}
For the list of tables use the field {TOC \t "TH" \c}.
Intellectual Property Rights
This unnumbered clause is the first required informative element and starts on a new page. The textblock is already included in ETSI skeletons and shall not be changed.
Foreword
This second unnumbered clause appears on the same page as the IPR clause. It is a required informative element and shall not contain requirements, figures or tables, except for the transposition table in European Standards (ENs). For ENs Harmonised Standards use the specific ETSI EN Harmonised Standard skeletons.
A pre-defined textblock is provided in ETSI skeletons.
More details about the foreword can be found in ETSI Drafting Rules, clause 2.5.
Foreword in ETSI multi-part deliverables
For multi-part ETSI deliverables, one of the following options shall be added to explain the relationship between the various parts in the series.
Option a)
In the Foreword of each part belonging to the series, a list of known parts and sub-parts with their titles shall be provided. One of the textblocks below can be used (see note).
Multi-part ETSI deliverables with parts (without sub-parts)
The present document is part <i> of a multi-part deliverable covering [the] <common element of the title>, as identified below:
Part 1: "<part element of the title>";
Part <i>: "<part element of the title>";
Part <n>: "<part element of the title>".
Multi-part ETSI deliverables containing parts and sub-parts
The present document is part <i>, sub-part <j> of a multi-part deliverable covering [the] <common element of the title>, as identified below:
Part 1: "<part element of the title>";
Part <i>: "<part element of the title>";
Sub-part 1: "<sub-part element of the title>";
Sub-part <j>: "<sub-part element of the title>";
Sub-part <m>: "<sub-part element of the title>".
Part <n>: "<part element of the title>".
NOTE: the <common element of the title> is the same for all parts;
the <part element of the title> differs from part to part; and if appropriate;
the <sub-part element of the title> differs from sub-part to sub-part.
The paragraph identifying the current part (and sub-part, if appropriate) shall be set in bold.
See an example in the Foreword of ETSI TS 100 392-3-15.
Option b)
In the Foreword of a specific part (usually part 1) a detailed list of all parts and/or subparts shall be provided using one of the textblock of option a) and the other parts and/or sub-parts will refer to it using the text block below:
The present document is part <i>, sub-part <j> of a multi-part deliverable. Full details of the entire series can be found in part <N> [Bookmark reference].
See an example in the Foreword of ETSI EN 301 489-28.
Additional text
Additional paragraphs, to be included in the Foreword, may be provided by the Technical Body giving as many of the following as are appropriate:
- an indication of any other organisation that has contributed to the preparation of the ETSI deliverable;
- a statement that the ETSI deliverable cancels and replaces other documents in whole or in part;
- a statement of significant technical changes from the previous version of the ETSI deliverable;
- the relationship of the ETSI deliverable to other ETSI deliverables or other documents;
- the existence of an electronic attachment accompanying the ETSI deliverables, if this is not mentioned elsewhere.
Transposition table for ENs
Each European Standard (EN) shall contain a transposition table as the last element in the Foreword. The table is already included in the ETSI skeleton. Harmonised Standards have appropriate transposition periods, see specific ETSI EN Harmonised Standard skeletons.
ETSI Drafting Rules, clauses 2.5.1 and 8.1.
Modal verbs terminology
This unnumbered clause is a required informative element that appears after the foreword. The textblock is already included in ETSI skeletons.
ETSI Drafting Rules, clause 2.6.
Executive summary
This unnumbered clause is an optional informative element and shall not contain requirements. It appears after "Modal verbs terminology" clause and before the introduction.
The "Executive summary" is used to summarise the ETSI deliverable. It should contain enough information for the readers to become acquainted with the full document without reading it. It is usually one page or shorter.
ETSI Drafting Rules, clause 2.7.
Introduction
This unnumbered clause is an optional informative element and shall not contain requirements. The "Introduction" clause may appear after the "Executive summary" clause (if present).
The "Introduction" clause may be used to give specific information or commentary about the technical content of the ETSI deliverable, and about the reasons prompting its preparation.
ETSI Drafting Rules, clause 2.8.
Scope
The "Scope" shall start on a new page and is clause number 1 of each ETSI deliverable. It is a required informative element and shall not contain requirements. For Harmonised Standards see also specific ETSI EN Harmonised Standard skeletons.
The "Scope" defines without ambiguity the subject of the ETSI deliverable and the aspect(s) covered, thereby indicating the limits of applicability of the ETSI deliverable or particular parts of it.
Forms of expression such as the following should be used:
The present document … EXAMPLE: The present document specifies high-level security and data protection provisions for consumer.
ETSI Drafting Rules, clause 2.9.
References
"References" is clause number 2 and shall list all the documents cited anywhere in an ETSI deliverable including its annexes. It shall consist of clause 2.1 "Normative references" and clause 2.2 "Informative references".
The appropriate textblocks for clauses 2.1.and 2.2 are already included in ETSI skeletons.
More details about the references can be found in ETSI Drafting Rules, clause 2.10.
Normative references
Normative references in normative ETSI deliverables (TS, EN, ES and GS)
Clause 2.1 in normative ETSI deliverables shall contain exclusively a numbered list of all normative references of an ETSI deliverable. These references have to be publicly available and in English. Documents provided in this list shall be normatively referenced provided that they contain technical requirements. This means that informative documents shall not be normatively referenced as they do not contain any normative requirements.
Legal acts can never be used as normative references. For EN Harmonised Standards see also specific ETSI EN Harmonised Standard skeletons.
Use the EX style, enclose the number in square brackets and separate it from the title with a tab (you may use sequence fields for automatically numbering references, see ETSI Drafting Rules, clause 6.9.2).
The document number or title shall incorporate hyperlinks to the sources where the references are available.
Use the NO style, if one or more notes accompanies the reference. Separate "NOTE:" from the text of the note with a tab. The note numbering restart on each reference entry.