Skip to main content

1.1 Formatting Structure

1.1.1 The formatting structure must use a numbered system with indentation to provide an easy to reference application of the documentation. This must be kept in sequence and not miss numbers or iterations as that can lead to readers believing that content is missing (unless that content is truly missing). The numbering will be structured as follows:

<chapter>.<page>.<ruleclause>.<sub_rulesub_clause>

1.1.1.1 All sub rulesclauses must be indented to provide a clear and visual divide of parent and child relationship between rulesclauses and sub rules.clauses.

1.1.1.2 Only lists within rulesclauses can break the standard demonstrated in rule 1.1.1 above. These lists can be used to do the following:

      • Unordered lists must be indented further to reflect being the child of a ruleclause or sub rule.clause.
      1. If appropriate, ordered lists can also be used to provide further referencing beside the ruleclause or sub rule.clause.
      1. If appropriate, ordered lists with letters can be used to provide further referencing beside the rule or sub rule.clause. This is not recommended when introducing an international audience where English is not their fluent language. 

        (NOTE: Unfortunately Bookstack does not provide the ability to create lettered lists without html scripting)

        <ol id="<random_id_number>" style="list-style: lower-alpha;">

1.1.2 RuleClause Headings - RulesClauses may have short headings which are denoted at the beginning of the ruleclause followed by a '-' dash and the corresponding rule.clause.

1.1.3 All rulesclauses and sub rulesclauses must be concisely written to prevent any misinterpretation of the subject matter or clause.

1.1.3.1 The use of tools such as ChatGPT and Gammarly are recommended to ensure concise use of literature in documentation.

1.1.4 The use of appendices as individual pages are recommended when referencing or illustrating material that can cloud the documentation written.

1.1.4.1 All appendices should be located at the end of a book under an Appendices chapter, with a hyperlink from the referencing page.

Back to top