From 18f406870e04d2b411d5f17d535de8a003f5191a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20=C5=A0o=C5=A1i=C4=87?= Date: Thu, 22 Feb 2024 14:59:11 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=98=83=F0=9F=9A=80=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- web/docs/writingguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/docs/writingguide.md b/web/docs/writingguide.md index 1ded0bf41d..ddc93422f0 100644 --- a/web/docs/writingguide.md +++ b/web/docs/writingguide.md @@ -105,7 +105,7 @@ This might seem redundant, but it makes our examples future-proof and helps reas ### Grammar -- **Don't use emojis (except in discussions).** Emojis are cute and friendly, but they can be a distraction in documentation. Some emojis even convey different meanings in different cultures. They also make the documentation seem unprofessional and of lower quality. +- **Use emojis sparingly (except in discussions).** Emojis are cute and friendly, but they can be a distraction in documentation. Some emojis even convey different meanings in different cultures. They also make the documentation seem unprofessional and of lower quality. That said, it can be ok to use them sparingly in certain situations, e.g. to visually emphasize a point in the text. - **Don't use memes and funny pictures.** Everything said about emojis applies to memes as well. It's hard to focus on the text and take it seriously when it contains jokes and memes. - **Avoid passive voice.** Instead of "The Wasp app can be deployed...", write "You can deploy the Wasp app..." - **Avoid abbreviations** in writing and code examples (e.g., `attribute` is better than `attr`, `message` is better than `msg`), unless you want to specifically reference an abbreviation in the API (e.g., the `auth` declaration). Abbreviation symbols included on standard keyboards (e.g., `@`, `#`, `&`) are OK.