mirror of
https://github.com/NixOS/nix.dev.git
synced 2024-10-18 00:06:26 -04:00
style guide: use culturally neutral language
This commit is contained in:
parent
41faf1b5b4
commit
a57f354e37
|
@ -14,3 +14,19 @@ Address the reader with "you" when necessary.
|
|||
Clarify identity if you use "we".
|
||||
Generally, "we" are the Nix community and, more specifically, nix.dev authors.
|
||||
|
||||
Use culturally neutral language:
|
||||
|
||||
- Avoid idioms.
|
||||
|
||||
Idioms can be hard to understand for non-native English speakers.
|
||||
|
||||
- Do not try to be funny.
|
||||
|
||||
Humor is highly culturally sensitive.
|
||||
At best, jokes may obfuscate the relevant instructions.
|
||||
At worst, jokes may offend readers and invalidate our effort to help them learn.
|
||||
|
||||
- Do not use references to popular culture.
|
||||
|
||||
What you may consider well-known may be entirely obscure and distracting to people from different backgrounds.
|
||||
|
||||
|
|
Loading…
Reference in a new issue