From a8c70fd7b937a04cd9476d0d8c0813e254e024b0 Mon Sep 17 00:00:00 2001 From: Nikola Kotur Date: Mon, 10 Jun 2019 16:12:48 +0200 Subject: [PATCH] Documentation is written, not spoken --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3522663..26568c2 100644 --- a/README.md +++ b/README.md @@ -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