From 29bd2af4048a4ee32cb04b8aaf464b39181ba55d Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Thu, 21 Oct 2021 08:50:42 +0200
Subject: [PATCH] Add guidelines

---
 doc.zih.tu-dresden.de/docs/contrib/content_rules.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md
index f5492e7f3..c3b3487c6 100644
--- a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+++ b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md
@@ -51,6 +51,10 @@ should be highlighted, etc. Code examples, longer than half screen height should
 ## Writing Style
 
 * 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
 
@@ -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
 * `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
 
 Showing commands and sample output is an important part of all technical documentation. To make
-- 
GitLab