EWG:Provision Format
From TEITAC
Editorial Working Group > Format of the Provisions
This page describes the format for provisions as they will appear in the TEITAC recommendations. There are templates ready to cut-and-paste into the wiki for both provisions with a consensus text and those with alternative versions.
Contents |
Templates
Cut and paste these templates for a provision. They are in the correct format to paste into the compiled version on the wiki. Examples as seen in the wiki
Basic template
This is the template for a provision where there is a single consensus version.
====Provision Title====
(Provision text goes here)
'''Discussion or Rationale''' (Discussion text goes here)
* ''Status: Done or In Progress''
* ''Text from Subcommittee''
* ''Source: {508}xxx, {255}xxx''
* ''Impact: ''
* ''External Reference: ''
* ''Testability: ''
* ''Metadata''
** ''Disabilities: ''
** ''User Activities: ''
** ''Product Characteristics: ''
** ''Product Types: ''
Template for alternatives
This is the template for a provision where there is more than one version, and no consensus on which one should be recommended. This template shows two versions, but more may be added. The information about impact, external references and testability may be different for each of the versions, and should be listed separately. Other metadata is listed after the final version.
====Provision Title====
This provision has alternative versions. Each version and its
rationale or justification are listed below.
=====Version 1=====
(Provision text goes here)
'''Rationale for Version 1''' (Where there are alternate versions,
each version must include a statement explaining the position or
rationale for the version.)
* ''Impact: ''
* ''External Reference: ''
* ''Testability: ''
=====Version 2=====
(Provision text goes here)
'''Rationale for Version 2''' (Where there are alternate versions,
each version must include a statement explaining the position or
rationale for the version.)
* ''Impact: ''
* ''External Reference: ''
* ''Testability: ''
* ''Status: In progress: no consensus reached''
* ''Text from Subcommittee''
* ''Source: {508}xxx, {255}xxx''
* ''Metadata''
** ''Disabilities: ''
'** 'User Activities: ''
** ''Product Characteristics: ''
**'' Product Types: ''
Template for a provision with a dispute over scope or interpretation
If there is a provision where there is consensus on the text, but a disagreement about how it should be interpreted, scoped, placed in the recommendations, etc. use this template.
=== Section Title ===
There is a dispute over how this provision should be interpreted. The two positions are:
'''Position 1''' (Where there is a dispute, there must be a statement
explaining the position of each side.)
'''Position 2''' (Where there is a dispute, there must be a statement
explaining the position of each side.)
====Provision Title====
(Provision text goes here)
'''Discussion or Rationale''' (Discussion text goes here)
* ''Status: Done or In Progress''
* ''Text from Subcommittee''
* ''Source: {508}xxx, {255}xxx''
* ''Impact: ''
* ''External Reference: ''
* ''Testability: ''
* ''Metadata''
** ''Disabilities: ''
** ''User Activities: ''
** ''Product Characteristics: ''
** ''Product Types: ''
====Provision Title====
(Provision text goes here)
(repeat provision text until the end of the section)
Details of the content of a provision
Each provision includes the following information:
Provision title, text and discussion
- Title - a short title or label that describes the content of the provision
- Provision text - recommended text of the provision (the regulatory text)
- Discussion (optional)- any notes on the rationale for the changes or other explanatory material. If the discussion material is long, a summary or introductory paragraph will be included with the provision, and the full discussion notes added in an annex.
Source, impact and testability information
- Source - the provision number(s) (i.e., {508}1194.21(e) ) this provision is derived from, or New
- Text from: Subcommittee - the name of the subcommittee managing this provision
- Impact - statement of change in economic impact and benefits from current regulations. Options are:
- No change
- Increase / decrease in economic impact
- Increase / decrease in benefits
- External References (optional)- any references to relevant external standards
- Testability (optional)- any notes on how the provision can be tested
Disabilities and activities metadata
To fill in the metadata fields, please work from the list of terms (linked from each label).
- Disabilities - list of disabilities this provision supports
- User Activities - examples of user activities this provision supports
- Product Characterisics - aspects of a product relevant to the provision
- Product Types - examples of types of products relevant to the provision
