This is a collection of writing rules for Hans. They are used in technical communication.
Rule
Correct
Incorrect
Reason
Use gerund form in section heading
Removing the lamp
Remove the lamp
Xxxxx
Use active form in step list heading
To remove the lamp
Removing the lamp
Xxxxx
Use infinitive form in summary tables, like maintenance schedule
Every day: Remove the lamp
Every day: Removing the lamp
Xxxxx
Rule
Correct
Incorrect
Reason
Do not use semicolon.
There are 3 screws: A, B and C
There are 3 screws; A, B and C.
In general there is no clear rules on how to interpret semicolon.
Do not use exclamation mark.
Take out the battery.
Take out the battery!
All instructions are important. If something is extra important it should be distinguished by other means.
Use hard space to keep objects that are related, together.
24 V, ABC 123
24 V, ABC 123
If hard space is not used, there might be a line break were the space is located: 24
V.
Rule
Correct
Incorrect
Reason
Use simple value range.
15-25 Hz
15 Hz to 25 Hz
15 Hz ... 25 Hz
15 Hz < f < 25 Hz
The value should be easy to understand.