From d44f9e1d7dff4360ef4b815cba3b92b969d85b08 Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Fri, 6 Oct 2023 16:10:04 +0530 Subject: [PATCH] Update docs/style-guide/grammar.md Signed-off-by: Arya Gupta Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> --- docs/style-guide/grammar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/style-guide/grammar.md b/docs/style-guide/grammar.md index 5b222b308..bbd314a8c 100644 --- a/docs/style-guide/grammar.md +++ b/docs/style-guide/grammar.md @@ -6,7 +6,7 @@ This document defines grammar standards for AsyncAPI documentation across abbrev When you use an abbreviation or acronym for the first time, spell it out and include the shortest form in parentheses. -Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. Once defined in a document, abbreviations or acronyms should be used consistently to ensure clarity and avoid confusion for readers +Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. Once defined in a document, abbreviations or acronyms should be used consistently to ensure clarity and avoid confusion for readers. Here are some examples of abbreviations: - ‘Event-driven architecture’ can be abbreviated as ‘EDA’.