Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
internal:rules [2018/05/04 15:14] – emrinternal:rules [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== General Rules for Writing Documentation ====== ====== General Rules for Writing Documentation ======
  
-==== Namespaces ====+=== Namespaces ===
  
-  * :general: Contains general terms and definitions, must be valid across all Stages versions +  * **:general:**  Contains general terms and definitions, must be valid across all Stages versions 
-  * :internal: Internal pages (e.g. this page) +  * **:internal:**  Internal pages (e.g. this page) 
-  * :72: Contains all documentation for Version 7.2 +  * **:72:**  Contains all documentation for Version 7.2 
-  * :73: see above for Version 7.3 (does not exist yet)+  * **:73:**  see above for Version 7.3 
 +  * **:74:**  see above for Version 7.4 
 +  * **:75:**  see above for Version 7.5 
 +New namespaces **shall only be created**  with the approval of the documentation product owner (currently emr).
  
-New namespaces **must only be created**  with the approval of the documentation manager (currently emr).+=== Page Layout ===
  
-==== Page Layout ====+  * The main heading of every page shall be formatted as "Heading 1". 
 +  * Pages shall be rather short and only describe a single Stages use case or feature. 
 +  * Subsequent headings on the page can be formatted as "Heading 2". "Heading 3" and further should be avoided. If the page needs more heading layers, you should introduce sub-pages.
  
-  * 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". +=== Work in Progress === 
-  * 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.+  * Every page or content that is not complete must have at least one "TBD" marker.