Skip to content

Remove assumption about why people read the documentation #12554

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 29, 2019
Merged

Remove assumption about why people read the documentation #12554

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions contributing/documentation/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,10 @@ In addition, documentation follows these rules:
* his or hers, use theirs
* himself or herself, use themselves

* **Avoid belittling words**: People read documentation because they know very
little about a specific topic or are even completely new to it. Things that
seem "obvious" or "simple" for the person documenting it, can be the exact
opposite for the reader. To make sure everybody feels comfortable when reading
the documentation, try to avoid words like:
* **Avoid belittling words**: Things that seem "obvious" or "simple" for the
person documenting it, can be the exact opposite for the reader. To make sure
everybody feels comfortable when reading the documentation, try to avoid words
like:

* basically
* clearly
Expand Down