File tree Expand file tree Collapse file tree 2 files changed +3
-1
lines changed
Expand file tree Collapse file tree 2 files changed +3
-1
lines changed Original file line number Diff line number Diff line change 3232 - Ensure that the tone is appropriate for technical documentation, maintaining a professional and informative style.
3333 - Verify that the structure of the document is logical and that headings and subheadings are used effectively.
3434 - Check for consistency in terminology and style throughout the document.
35+ - Use active voice instead of passive voice
36+ - Use present tense and **avoid future tense**!
Original file line number Diff line number Diff line change @@ -41,11 +41,11 @@ There are a couple of aspects that are easy to consider when writing w/o digging
4141
4242 This sound easier than it is, but if you can put it in simpler words, it gets automatically clearer and more helpful.
4343
44+ - Use present tense and ** avoid future tense** !
4445- Avoid emoticons and emojis.
4546- Do NOT remove TODO markers at all.
4647- Do NOT remove tip, warning or danger notes indicated by ` ... tip ` or similar constructs.
4748
48- - Use present and avoid future tense!
4949
5050The documentation should follow the here described style guidance so that it keeps a consistent external and internal appearance:
5151
You can’t perform that action at this time.
0 commit comments