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

Merge pull request #4 from teo8192/patch-1

Browse Source 
Negated a sentance
This commit is contained in:
Kyle Lobo
2019-06-05 16:16:27 +05:30
committed by GitHub
parent 470a2206d7 9f71497fc8
commit 632680a3a1
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

@@ -40,7 +40,7 @@
+ 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 clutter explanations with overly detailed examples
+ Use terms that are _offensive_ to any group. There will never be a good reason to
+ Don't use terms that are _offensive_ to any group. There will never be a good reason to
## 👨‍💻 Technical Writing Programs <a name = "programs"></a>
1. [A List of Open Source Projects with Volunteer Documentation Opportunities](https://www.reddit.com/r/technicalwriting/comments/800a9a/a_list_of_open_source_projects_with_volunteer/)