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 product owner (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 “Normal” text.
  • The main heading of every page immediately follows the link back (see above) and must be formatted as “Heading 1”.
  • Pages shall be rather short and only describe a single Stages use case.
  • Subsequent headings on the page can be formatted as “Heading 4”. Deeper hierarchies shall only be created with the approval of the documentation product owner. “Heading 2” and “Heading 3” generate rather ugly in-page navigation and must therefore not be used.