File tree Expand file tree Collapse file tree 1 file changed +14
-0
lines changed
contributing/documentation/style-guide Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change @@ -42,6 +42,20 @@ To ensure consistency with grammar and sentences, this rule will give an error i
4242
4343An exception to this rule would be when listing items or names that use _ camelcase_ .
4444
45+ ### Language Guidelines
46+
47+ Use the following language rules to keep the documentation clear and user-focused:
48+
49+ * ** Write in the second person** : Address the reader directly using "you."
50+ * ⛔ "The user should add the Document Type by clicking the Add button."
51+ * ✅ “You can add the Document Type under…”
52+ * ** Use the present tense and active voice** :
53+ * ⛔ “The Document Type was added…”
54+ * ✅ “You can now test whether it works.”
55+ * ** Avoid using "it" or "this" as vague references** : Always replace them with what they refer to, unless used within the same sentence.
56+ * ⛔ “This can now be configured.”
57+ * ✅ “The Document Type can now be configured.”
58+
4559### Long sentences
4660
4761This rule will give a warning if you have a sentence with more than 25 words.
You can’t perform that action at this time.
0 commit comments