info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-03 01:52:42 +02:00
Code Issues Releases Wiki Activity

Merge pull request #8 from kotnik/patch-1

Browse Source 
Documentation is written, not spoken
This commit is contained in:
Kyle Lobo
2019-06-10 20:47:10 +05:30
committed by GitHub
parent 59689994cd a8c70fd7b9
commit 6310981614
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -66,7 +66,7 @@ Even if for some reason they have to use it because they have no choice, without
**❌ Things you should avoid:**
- Don't assume prior knowledge about the topic. If you want to appeal to a large audience, then you are going to have people with very diverse backgrounds
- Don't use idioms. Speak using more formal terms that are well defined. This makes it easier for non-native English speakers and for translations to be written
- Don't use idioms. Write using more formal terms that are well defined. This makes it easier for non-native English speakers and for translations to be written
- Don't clutter explanations with overly detailed examples
- Don't use terms that are offensive to any group. There will never be a good reason to