EWG:Styleguide
From TEITAC
Contents |
TEITAC Style Guide
This page collects decisions by the EWG on the style and format of the provisions. It's a work in progress.
Simple terminology and punctuation styles
- Use must (not shall)
- Use users (not end-users). If a provision applies to a specific group of people, name them explicitly.
- Use "people first" wording: "people with disabilities"
- Use serial commas. Include the final comma before "and" or "or" - makes clear the grouping of items in a list.
- Example: "This applies to red dogs, green or yellow dogs, striped and dotted dogs, and dogs with long tails"
Style guidelines that require actual editing
- Use active voice
- Where there is a general rule, with specific conditions or exceptions, list the rule first, and then the exceptions. Example:
Products must do this. This is the statement of the general rule.
- In this situation, this is the rule
- In this condition, there is an exception
How to mark changes
We will not track specific changes to the text in the compiled versions, but will note if a provision is unchanged from a previous version.
- Some provisions haven't changed since the original 508, or since the May 30 draft. We'll include this information in the Source tag. Examples:
- Source: {508}1194.31(a) (no changes)
- Source: {508}1194.31(a) (no changes since May 30 draft)
- Source: New
- For provisions that are in a new section, include the number from the May 30 draft in source:
- Source: {508}1194.31(a) (was 1.1.X in May 30 draft)
- Source: {508}1194.31(a) (was 1.1.X in May 30 draft - no text changes)
(Last updated 2 July)
