Skip to content

Commit

Permalink
Update docs/style-guide/grammar.md
Browse files Browse the repository at this point in the history
Signed-off-by: Arya Gupta <[email protected]>

Co-authored-by: V Thulisile Sibanda <[email protected]>
  • Loading branch information
Arya-Gupta and thulieblack authored Oct 6, 2023
1 parent 3b44330 commit d44f9e1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/style-guide/grammar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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’.
Expand Down

0 comments on commit d44f9e1

Please sign in to comment.