Skip to content
Snippets Groups Projects
Commit 29bd2af4 authored by Martin Schroschk's avatar Martin Schroschk
Browse files

Add guidelines

parent 31abd0f7
No related branches found
No related tags found
3 merge requests!392Merge preview into contrib guide for browser users,!387Merge preview into main,!384Improve documentation on how to create issue
...@@ -51,6 +51,10 @@ should be highlighted, etc. Code examples, longer than half screen height should ...@@ -51,6 +51,10 @@ should be highlighted, etc. Code examples, longer than half screen height should
## Writing Style ## Writing Style
* Capitalize headings, e.g. *Exclusive Reservation of Hardware* * Capitalize headings, e.g. *Exclusive Reservation of Hardware*
* Use active over passive voice
* Write with confidence. This confidence should be reflected in the documentation, so that
the readers trust and follow it.
* Example: `We recommend something` instead of `Something is recommended.`
## Spelling and Technical Wording ## Spelling and Technical Wording
...@@ -64,6 +68,12 @@ there is a list of conventions w.r.t. spelling and technical wording. ...@@ -64,6 +68,12 @@ there is a list of conventions w.r.t. spelling and technical wording.
* `ZIH system` and `ZIH systems` not `Taurus` etc. if possible * `ZIH system` and `ZIH systems` not `Taurus` etc. if possible
* `Workspace` not `work space` * `Workspace` not `work space`
### Long Options
* Use long over short options, e.g. `srun --nodes=2 --ntasks-per-node=4 ...` is prefered over
`srun -N 2 -n 4 ...`
* Use `module` over the short front-end `ml` in documentation and examples
## Code Blocks and Command Prompts ## Code Blocks and Command Prompts
Showing commands and sample output is an important part of all technical documentation. To make Showing commands and sample output is an important part of all technical documentation. To make
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment