This is an old revision of the document!


General Rules for Writing Documentation

Namespaces

  • :general: Contains general terms and definitions, must be valid across all Stages versions
  • :internal: Internal pages (e.g. this page)
  • :72: Contains all documentation for Version 7.2
  • :73: see above for Version 7.3 (does not exist yet)

New namespaces must only be created with the approval of the documentation manager (currently emr).

Page Layout

  • Every page in a namespace must start with a link back to the “start” page of this namespace (only if the start page exists!). This link must be formatted as “Heading 5”.
  • The main heading of every page must be formatted as “Heading 1”.
  • Subsequent headings on the page can be formatted as “Heading 3” and “Heading 4”. Deeper hierarchies shall not be created.