1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 14:32:43 -04:00

style guide: use culturally neutral language

This commit is contained in:
Valentin Gagarin 2022-07-29 01:21:59 +02:00
parent 41faf1b5b4
commit a57f354e37

View file

@ -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.