Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
internal:rules [2018/05/04 15:14] – emr | internal: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, | + | |
- | * :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 **shall only be created** | ||
- | New namespaces **must only be created** | + | === Page Layout === |
- | ==== Page Layout ==== | + | * The main heading of every page shall be formatted as " |
+ | * Pages shall be rather short and only describe a single Stages use case or feature. | ||
+ | * Subsequent headings on the page can be formatted as " | ||
- | * Every page in a namespace must start with a link back to the " | + | === Work in Progress === |
- | * The main heading of every page must be formatted as "Heading 1". | + | |
- | * Subsequent headings on the page can be formatted as " | + | * Every page or content that is not complete |