Rapporteurs Guide: Difference between revisions
No edit summary |
|||
| (18 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
When new Rapporteurs start working on a draft for ETSI for the first time, it is recommended to read this guide or view the [https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/Guides/ETSI_Rapporteurs_guide.mp4 video presentation]. | When new Rapporteurs start working on a draft for ETSI for the first time, it is recommended to read this guide or view the [https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/Guides/ETSI_Rapporteurs_guide.mp4 video presentation]. | ||
==Drafting your 1<sup>st</sup> deliverable== | ==Drafting your 1<sup>st</sup> deliverable== | ||
For a 1<sup>st</sup> ETSI Deliverable, it is recommended to read the booklet called Writing World Class Standards available | For a 1<sup>st</sup> ETSI Deliverable, it is recommended to read the booklet called Writing World Class Standards available [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/#p=1 on this webpage]. | ||
This booklet starts with the basics for Rapporteurs who are new to standardization or new to ETSI. | This booklet starts with the basics for Rapporteurs who are new to standardization or new to ETSI. | ||
Guidance follows on how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/ choose the right type of standard], how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/ structure a standard] and draft it, how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/ express the technical requirements] and finally how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/ validate, test and maintain] a standard. | Guidance follows on how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/#p=8 choose the right type of standard], how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/#p=14 structure a standard] and draft it, how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/#p=22 express the technical requirements] and finally how to [https://www.etsi.org/e-brochure/WritingWorldClassStandards/mobile/#p=29 validate, test and maintain] a standard. | ||
==Start drafting a revision== | ==Start drafting a revision== | ||
If it's not a 1<sup>st</sup> publication but a revision of an already published ETSI Deliverable to be produced, it is essential to start working on '''the latest published version'''. In case it is not sure the version you have is the latest version, it is necessary to search in the right place for the proper version.[[File:Figure_1_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_1_Rap_guide.jpg]][[File:Figure_2_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_2_Rap_guide.jpg]] | If it's not a 1<sup>st</sup> publication but a revision of an already published ETSI Deliverable to be produced, it is essential to start working on '''the latest published version'''. In case it is not sure the version you have is the latest version, it is necessary to search in the right place for the proper version.[[File:Figure_1_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_1_Rap_guide.jpg]][[File:Figure_2_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_2_Rap_guide.jpg]] | ||
=Personal information= | |||
== Personal information == | |||
The ETSI Secretariat shall keep the Rapporteur informed all along the process of the development of the ETSI Deliverable. It is essential that all recorded personal details are accurate. | The ETSI Secretariat shall keep the Rapporteur informed all along the process of the development of the ETSI Deliverable. It is essential that all recorded personal details are accurate. | ||
If not, there is a risk that this could delay the timeline of the work schedule. The name of the Rapporteur should always be provided. Please access personal details by clicking | If not, there is a risk that this could delay the timeline of the work schedule. The name of the Rapporteur should always be provided. Please access personal details by clicking [https://portal.etsi.org/webapp/teldir/PersonalInfo.asp here] where it is possible to update if needed. If difficulties are experienced when updating these details, just inform the ETSI Secretariat that corrections are needed and the Technical Officer or the Standardization Support Professional or '''''editHelp!''''' can update the information. | ||
==ETSI skeletons== | ==ETSI skeletons== | ||
If a new ETSI Deliverable is to be drafted, the best way to start is to download the proper skeleton. These can be downloaded from | If a new ETSI Deliverable is to be drafted, the best way to start is to download the proper skeleton. These can be downloaded from [https://portal.etsi.org/Services/editHelp/Standards-development/Drafting/Skeletons this page]. | ||
[[File:TS skeleton.Word.jpg|center|frame]] | |||
https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/Principles_for_drafting_ETSI_deliverables.pdf. | == ETSI skeletons and guide == | ||
At the same time and from the same location, please download the guide named "[https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/Principles_for_drafting_ETSI_deliverables.pdf Principles for drafting an ETSI deliverable with the use of skeletons]". | |||
This guide contains all the details needed when drafting an ETSI Deliverable. It follows the complete structure of the draft from beginning to end, starting with the cover page and ending with the history box.[[File:Figure_4_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_4_Rap_guide.jpg]]For example, it gives guidance on references, terms, symbols, abbreviations and details on ETSI styles on how they are supposed to be used and much more following the skeletons' structure. | This guide contains all the details needed when drafting an ETSI Deliverable. It follows the complete structure of the draft from beginning to end, starting with the cover page and ending with the history box.[[File:Figure_4_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_4_Rap_guide.jpg]]For example, it gives guidance on references, terms, symbols, abbreviations and details on ETSI styles on how they are supposed to be used and much more following the skeletons' structure. | ||
| Line 28: | Line 29: | ||
All the information is summed up in this document to facilitate the drafting from an editing point of view. | All the information is summed up in this document to facilitate the drafting from an editing point of view. | ||
==ETSI videos== | ==ETSI videos== | ||
[[File:Figure_5_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_5_Rap_guide.jpg]]For a better understanding and a simplified use of the ETSI styles, it is suggested to watch these videos available | [[File:Figure_5_Rap_guide.jpg|frame|center|link=https://help.etsi.org/index.php?title=File:Figure_5_Rap_guide.jpg]]For a better understanding and a simplified use of the ETSI styles, it is suggested to watch these videos available [https://portal.etsi.org/Services/editHelp/Standards-development/Drafting/Styles-toolbar here]. | ||
=ETSI Drafting Rules (EDRs)= | |||
In order to draft an ETSI Deliverable, please refer to the ETSI Drafting Rules document - commonly named "EDRs", which is available | == ETSI Drafting Rules (EDRs) == | ||
In order to draft an ETSI Deliverable, please refer to the ETSI Drafting Rules document - commonly named "EDRs", which is available [https://docbox.etsi.org/Board/ETSI_Directives on this webpage]. | |||
Every year, the ETSI Secretariat studies the necessity to review these rules. | Every year, the ETSI Secretariat studies the necessity to review these rules. | ||
It is essential to use the latest updated version of the EDRs when drafting an ETSI deliverable. | It is essential to use the latest updated version of the EDRs when drafting an ETSI deliverable. | ||
=Set of rules= | |||
== Set of rules == | |||
These set of rules state what is permitted and what is not when drafting an ETSI Deliverable. | These set of rules state what is permitted and what is not when drafting an ETSI Deliverable. | ||
| Line 44: | Line 47: | ||
It is possible to find all verbal forms for the expression of provisions which are explicitly specified in the EDRs (see clause 3). Depending on the nature of the ETSI Deliverable being drafted – some provisions are not permitted. | It is possible to find all verbal forms for the expression of provisions which are explicitly specified in the EDRs (see clause 3). Depending on the nature of the ETSI Deliverable being drafted – some provisions are not permitted. | ||
Reproduction of third-party material is allowed only under very strict conditions in ETSI Deliverables, and this is the same with the use of tradenames and trademarks. Some communiqués have been produced to provide more guidance regarding these sensitive topics. All are available | Reproduction of third-party material is allowed only under very strict conditions in ETSI Deliverables, and this is the same with the use of tradenames and trademarks. Some communiqués have been produced to provide more guidance regarding these sensitive topics. All are available on this [https://portal.etsi.org/Services/editHelp/How-to-start/ETSI-Drafting-News webpage]. | ||
=The use of gender-inclusive language guide= | |||
== The use of gender-inclusive language guide == | |||
"Using gender-inclusive language means speaking and writing in a way that does not discriminate against a particular sex, social gender or gender identity, and does not perpetuate gender stereotypes. Given the key role of language in shaping cultural and social attitudes, using gender-inclusive language is a powerful way to promote gender equality and eradicate gender bias". | "Using gender-inclusive language means speaking and writing in a way that does not discriminate against a particular sex, social gender or gender identity, and does not perpetuate gender stereotypes. Given the key role of language in shaping cultural and social attitudes, using gender-inclusive language is a powerful way to promote gender equality and eradicate gender bias". | ||
https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/Guides/Use_gender_inclusive_language.pdf | [https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/Guides/Use_gender_inclusive_language.pdf Use of gender inclusive language guide] | ||
=Standards’ production time= | |||
== Standards’ production time == | |||
How long does it take to get a ETSI Deliverable published? | How long does it take to get a ETSI Deliverable published? | ||
This depends on the type of ETSI Deliverable being produced. For example, the process is different if it is a GS or an EN. | This depends on the type of ETSI Deliverable being produced. For example, the process is different if it is a GS or an EN. | ||
All the details are available | All the details are available on this [https://ocgwiki.etsi.org/index.php?title=ETSI_Standards_Making_Process_Guide webpage]. | ||
=Making a contribution on the ETSI Portal= | |||
Information on how to use the Contribution tool on the ETSI Portal, can be found | == Making a contribution on the ETSI Portal == | ||
=Clean-up service= | Information on how to use the Contribution tool on the ETSI Portal, can be found on this [https://help.etsi.org/index.php?title=Contributions_application webpage]. | ||
== Clean-up service == | |||
It is impossible to publish an ETSI Deliverable which is not compliant with the ETSI Drafting Rules. | It is impossible to publish an ETSI Deliverable which is not compliant with the ETSI Drafting Rules. | ||
| Line 64: | Line 71: | ||
This service is dedicated to prevent any misunderstanding and thus helps raise all blocking issues and offers practical solutions before the approval of the draft. | This service is dedicated to prevent any misunderstanding and thus helps raise all blocking issues and offers practical solutions before the approval of the draft. | ||
All the details are available on the communiqué available | All the details are available on the communiqué available [https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/News_from_editHelp/ETSI_clean-up_service.pdf here]. | ||
=Editing checklist= | |||
An editing checklist is available | == Editing checklist == | ||
An editing checklist is available [https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/ETSI_editing_checklist.pdf here]. | |||
It is recommended to compare the items presented on the list with the content of the ETSI Deliverable to make sure that it is compliant with the EDRs. If doubts subsist, please contact the ETSI Secretariat (either the Technical Officer, the Support Standardization Professional or '''''editHelp!''''') for support and to help solve these issues. | It is recommended to compare the items presented on the list with the content of the ETSI Deliverable to make sure that it is compliant with the EDRs. If doubts subsist, please contact the ETSI Secretariat (either the Technical Officer, the Support Standardization Professional or '''''editHelp!''''') for support and to help solve these issues. | ||
This document can found by clicking | == Some blocking issues == | ||
=FAQ= | A document has been produced which lists the most frequent issues encountered by '''''editHelp!''''' that block the publication of an ETSI Deliverable if not properly addressed beforehand. | ||
If looking for an answer to a specific question, please consult the FAQ, by clicking | |||
This document can found by clicking [https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/News_from_editHelp/editHelp_10_most_asked_editing_questions.pdf here]. | |||
== FAQ == | |||
If looking for an answer to a specific question, please consult the FAQ, by clicking [https://portal.etsi.org/Services/editHelp/To-help-you-in-your-work/FAQs here]. | |||
If the answer cannot be found, it is recommended to contact '''''[https://portal.etsi.org/Services/editHelp/Contact-Us editHelp!]'''.'' | |||
== '''''[https://portal.etsi.org/Services/editHelp editHelp]'''''! website == | |||
To know more about '''''editHelp!''''' services, please watch the video tour of the '''''[https://portal.etsi.org/Services/editHelp/How-to-start/editHelp-introduction editHelp]'''''! website. | |||
== All the links provided in this presentation are listed below == | |||
= | |||
=All the links provided in this presentation are listed below= | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
| Line 92: | Line 104: | ||
|- | |- | ||
|How to get in touch with '''''editHelp!''''' | |How to get in touch with '''''editHelp!''''' | ||
|https://portal.etsi.org/Services/editHelp/Contact-Us | |https://portal.etsi.org/Services/editHelp/Contact-Us | ||
|- | |- | ||
|ETSI booklet on how to draft ETSI Deliverables | |ETSI booklet on how to draft ETSI Deliverables | ||
| Line 98: | Line 110: | ||
|- | |- | ||
|Advanced search for ETSI Deliverables | |Advanced search for ETSI Deliverables | ||
|https://portal.etsi.org/webapp/WorkProgram/Expert/QueryForm.asp | |https://portal.etsi.org/webapp/WorkProgram/Expert/QueryForm.asp | ||
|- | |- | ||
|'''''editHelp!''''' email address | |'''''editHelp!''''' email address | ||
| Line 104: | Line 116: | ||
|- | |- | ||
|Application to update your personal details | |Application to update your personal details | ||
|https://portal.etsi.org/webapp/teldir/PersonalInfo.asp | |https://portal.etsi.org/webapp/teldir/PersonalInfo.asp | ||
|- | |- | ||
|Find all ETSI skeletons (pre-built deliverables) | |Find all ETSI skeletons (pre-built deliverables) | ||
|https://portal.etsi.org/Services/editHelp/Standards-development/Drafting/Skeletons | |https://portal.etsi.org/Services/editHelp/Standards-development/Drafting/Skeletons | ||
|- | |- | ||
|Step by step guide to help you drafting | |Step by step guide to help you drafting | ||
| Line 113: | Line 125: | ||
|- | |- | ||
|Short cut to ETSI styles | |Short cut to ETSI styles | ||
|https://portal.etsi.org/Services/editHelp/Standards-development/Drafting/Styles-toolbar | |https://portal.etsi.org/Services/editHelp/Standards-development/Drafting/Styles-toolbar | ||
|- | |- | ||
|ETSI Drafting Rules | |ETSI Drafting Rules | ||
|https://portal.etsi.org/Services/editHelp/How-to-start/ETSI-Drafting-Rules | |https://portal.etsi.org/Services/editHelp/How-to-start/ETSI-Drafting-Rules | ||
|- | |- | ||
|ETSI Directives | |ETSI Directives | ||
|https://docbox.etsi.org/Board/ETSI_Directives/ | |https://docbox.etsi.org/Board/ETSI_Directives/ | ||
|- | |- | ||
|News from '''''editHelp!''''' | |News from '''''editHelp!''''' | ||
|https://portal.etsi.org/Services/editHelp/How-to-start/ETSI-Drafting-News | |https://portal.etsi.org/Services/editHelp/How-to-start/ETSI-Drafting-News | ||
|- | |- | ||
|Information on the ETSI Standards Making Process | |Information on the ETSI Standards Making Process | ||
|https://portal.etsi.org/Resources/Standards-Making-Process/Process | |https://portal.etsi.org/Resources/Standards-Making-Process/Process | ||
|- | |- | ||
|Clean-up service (information) | |Clean-up service (information) | ||
Latest revision as of 07:19, 12 September 2025
How to get started with your ETSI drafting
This Rapporteur’s guide has been developed to give an overview of what is useful to know when drafting an ETSI Deliverable.
When new Rapporteurs start working on a draft for ETSI for the first time, it is recommended to read this guide or view the video presentation.
Drafting your 1st deliverable
For a 1st ETSI Deliverable, it is recommended to read the booklet called Writing World Class Standards available on this webpage.
This booklet starts with the basics for Rapporteurs who are new to standardization or new to ETSI.
Guidance follows on how to choose the right type of standard, how to structure a standard and draft it, how to express the technical requirements and finally how to validate, test and maintain a standard.
Start drafting a revision
If it's not a 1st publication but a revision of an already published ETSI Deliverable to be produced, it is essential to start working on the latest published version. In case it is not sure the version you have is the latest version, it is necessary to search in the right place for the proper version.
Personal information
The ETSI Secretariat shall keep the Rapporteur informed all along the process of the development of the ETSI Deliverable. It is essential that all recorded personal details are accurate.
If not, there is a risk that this could delay the timeline of the work schedule. The name of the Rapporteur should always be provided. Please access personal details by clicking here where it is possible to update if needed. If difficulties are experienced when updating these details, just inform the ETSI Secretariat that corrections are needed and the Technical Officer or the Standardization Support Professional or editHelp! can update the information.
ETSI skeletons
If a new ETSI Deliverable is to be drafted, the best way to start is to download the proper skeleton. These can be downloaded from this page.
ETSI skeletons and guide
At the same time and from the same location, please download the guide named "Principles for drafting an ETSI deliverable with the use of skeletons".
This guide contains all the details needed when drafting an ETSI Deliverable. It follows the complete structure of the draft from beginning to end, starting with the cover page and ending with the history box.
For example, it gives guidance on references, terms, symbols, abbreviations and details on ETSI styles on how they are supposed to be used and much more following the skeletons' structure.
It also explains how to deal with figures, tables, equations, mathematical formulae, supplementary files, etc.
All the information is summed up in this document to facilitate the drafting from an editing point of view.
ETSI videos
For a better understanding and a simplified use of the ETSI styles, it is suggested to watch these videos available here.
ETSI Drafting Rules (EDRs)
In order to draft an ETSI Deliverable, please refer to the ETSI Drafting Rules document - commonly named "EDRs", which is available on this webpage.
Every year, the ETSI Secretariat studies the necessity to review these rules.
It is essential to use the latest updated version of the EDRs when drafting an ETSI deliverable.
Set of rules
These set of rules state what is permitted and what is not when drafting an ETSI Deliverable.
Whether dealing with normative references or informative references, normative provisions and informative recommendations the rules are not the same depending on the type of ETSI Deliverable worked on.
European Harmonised Standards have specific rules which are not the same as with Technical Reports.
It is possible to find all verbal forms for the expression of provisions which are explicitly specified in the EDRs (see clause 3). Depending on the nature of the ETSI Deliverable being drafted – some provisions are not permitted.
Reproduction of third-party material is allowed only under very strict conditions in ETSI Deliverables, and this is the same with the use of tradenames and trademarks. Some communiqués have been produced to provide more guidance regarding these sensitive topics. All are available on this webpage.
The use of gender-inclusive language guide
"Using gender-inclusive language means speaking and writing in a way that does not discriminate against a particular sex, social gender or gender identity, and does not perpetuate gender stereotypes. Given the key role of language in shaping cultural and social attitudes, using gender-inclusive language is a powerful way to promote gender equality and eradicate gender bias".
Use of gender inclusive language guide
Standards’ production time
How long does it take to get a ETSI Deliverable published?
This depends on the type of ETSI Deliverable being produced. For example, the process is different if it is a GS or an EN.
All the details are available on this webpage.
Making a contribution on the ETSI Portal
Information on how to use the Contribution tool on the ETSI Portal, can be found on this webpage.
Clean-up service
It is impossible to publish an ETSI Deliverable which is not compliant with the ETSI Drafting Rules.
To avoid such a situation, editHelp! proposes a service called "clean-up”, where it is possible to submit a draft once stable enough to be 'cleaned-up' to editHelp!.
This service is dedicated to prevent any misunderstanding and thus helps raise all blocking issues and offers practical solutions before the approval of the draft.
All the details are available on the communiqué available here.
Editing checklist
An editing checklist is available here.
It is recommended to compare the items presented on the list with the content of the ETSI Deliverable to make sure that it is compliant with the EDRs. If doubts subsist, please contact the ETSI Secretariat (either the Technical Officer, the Support Standardization Professional or editHelp!) for support and to help solve these issues.
Some blocking issues
A document has been produced which lists the most frequent issues encountered by editHelp! that block the publication of an ETSI Deliverable if not properly addressed beforehand.
This document can found by clicking here.
FAQ
If looking for an answer to a specific question, please consult the FAQ, by clicking here.
If the answer cannot be found, it is recommended to contact editHelp!.
editHelp! website
To know more about editHelp! services, please watch the video tour of the editHelp! website.