Skip to content

Added a section about belittling words to the documentation standars #11685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions contributing/documentation/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,27 @@ In addition, documentation follows these rules:
* his or hers, use theirs
* himself or herself, use themselves

Moreover, we try to avoid belittling words as much as possible. Usually, the people
that write documentation write about a topic they are very familiar with. Thus, they
tend to include words like "simply" or "obviously" as things may seem simple or obvious
to them. However, the future reader is going to read the documentation because they
know very little about a specific topic or are even completely new to it which means
they might feel the exact opposite.
To make sure everybody feels comfortable when reading the documentation, try to avoid
words like:

* simply
* just
* easy/easily
* quick/quickly
* of course
* logically
* clearly
* obviously
* merely
* basically
* trivial

.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code
.. _`Twig Coding Standards`: https://twig.symfony.com/doc/2.x/coding_standards.html
.. _`reserved by the IANA`: http://tools.ietf.org/html/rfc2606#section-3
Expand Down