#all #documentation #standard

1 Purpose

The purpose of this document is to formalize the format of Standards in the Team Notebook.

2 Scope

All team members.

3 Common format

Authors shall adhere to a common format when writing Standards.

3.1 Locate tags at the start

Authors shall add tags to the top of the document before the first section heading.

3.2 Add standard sections

In this order, authors of a Standard shall include the following sections:

1. Purpose
2. Scope

3.2.1 Write the purpose section

The authors shall describe the purpose of the document.

3.2.2 Write the scope section

The authors shall describe describe which Departments or Roles the Standard applies to.

If the authors intends for the Standard to apply to everyone, they shall explicitly state that it applies to all departments and team members.

In this case authors shall tag the document with: "all" in addition to any other tags.

4 General guidelines

4.1 Standards are for internal rules and facts

Standards constitute:

• rules that must be followed
• facts that affected team members should know
• process that team members are expected to know

4.2 Use descriptive headings for rules

Like the heading of this sub-section, authors shall use headings to convey a summaries of rules.

4.3 Use normal section titles for definitions and categories

Where writing a heading for a definition, or a section containing a category of rules or definitions, authors shall write headings as normal chapter or section titles.

4.4 Use "shall" statements

Where defining specific action to be taken by any entity, authors shall use the word "shall" in lieu of its synonyms.

4.5 Avoid using passive voice in "shall" statements

Authors shall explicitly state who or what is responsible for performing specific action if at all possible.

4.6 Standards shall be traceable to a single source

All authors shall ensure standards are traceable to S0-Organizing_Manual by links.

Another Standard must link to the Standard except for S0-Organizing_Manual which is the origin for all other Standards.

5 Approval

A change to the team Standards constitutes any addition, edit, or deletion of a standard.

Approval or disapproval of any change to team Standards shall take the form of a unanimous vote subject to the following rules.

5.1 Full members shall approve Standards

Only Full Members shall vote to approve or disapprove changes to the team Standards.

5.2 Affected members shall be approve Standards

Only members affected by the Standard, as outlined by its Scope, shall vote to approve or disapprove changes to the team Standards.