File tree Expand file tree Collapse file tree 1 file changed +18
-0
lines changed
contributing/documentation Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Original file line number Diff line number Diff line change @@ -173,6 +173,24 @@ In addition, documentation follows these rules:
173173 * his or hers, use theirs
174174 * himself or herself, use themselves
175175
176+ * **Avoid belittling words **: People read documentation because they know very
177+ little about a specific topic or are even completely new to it. Things that
178+ seem "obvious" or "simple" for the person documenting it, can be the exact
179+ opposite for the reader. To make sure everybody feels comfortable when reading
180+ the documentation, try to avoid words like:
181+
182+ * basically
183+ * clearly
184+ * easy/easily
185+ * just
186+ * logically
187+ * merely
188+ * obviously
189+ * of course
190+ * quick/quickly
191+ * simply
192+ * trivial
193+
176194.. _`the Sphinx documentation` : http://sphinx-doc.org/rest.html#source-code
177195.. _`Twig Coding Standards` : https://twig.symfony.com/doc/2.x/coding_standards.html
178196.. _`reserved by the IANA` : http://tools.ietf.org/html/rfc2606#section-3
You can’t perform that action at this time.
0 commit comments