Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: new style guide - Grammar #1343

Closed
wants to merge 29 commits into from
Closed
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b4ed1b7
Added new styleguide - grammer.md
Arya-Gupta Feb 14, 2023
44ada9a
Merge branch 'asyncapi:master' into styleguide-grammar
Arya-Gupta Apr 4, 2023
0c8d149
Create _section.md
Arya-Gupta Apr 4, 2023
0084dac
Create _section.md
Arya-Gupta Apr 4, 2023
331843f
Create index.md
Arya-Gupta Apr 4, 2023
4511ec0
Create index.md
Arya-Gupta Apr 4, 2023
d9885fe
Merge branch 'asyncapi:master' into styleguide-grammar
Arya-Gupta Apr 4, 2023
81a0226
Merge branch 'asyncapi:master' into styleguide-grammar
Arya-Gupta Apr 11, 2023
9bb36cf
Update pages/docs/community/_section.md
Arya-Gupta Apr 11, 2023
7113f9c
Update pages/docs/community/styleguide/grammar.md
Arya-Gupta Apr 11, 2023
ce8f3d4
Delete _section.md
Arya-Gupta Apr 11, 2023
3683040
Delete index.md
Arya-Gupta Apr 11, 2023
4982603
Update pages/docs/community/index.md
Arya-Gupta Apr 12, 2023
8bebc96
Merge branch 'master' into styleguide-grammar
quetzalliwrites Jun 7, 2023
1be7703
Merge branch 'asyncapi:master' into styleguide-grammar
Arya-Gupta Jun 10, 2023
6aeec8d
Incorporated feedback into the style guide
Arya-Gupta Jun 10, 2023
00deace
Merge branch 'master' into styleguide-grammar
quetzalliwrites Jun 13, 2023
1bc3f11
fixing community content bucket weight
quetzalliwrites Jun 13, 2023
2599ff8
Another editorial round
quetzalliwrites Jun 13, 2023
59ccb0e
Merge branch 'asyncapi:master' into styleguide-grammar
Arya-Gupta Jun 13, 2023
fc6ac28
Added introduction to Grammar style guide
Arya-Gupta Jun 13, 2023
3dd3759
Merge branch 'styleguide-grammar' of https://github.com/Arya-Gupta/we…
Arya-Gupta Jun 13, 2023
2e97c7f
grammar improvements
quetzalliwrites Jun 16, 2023
43596d8
remove slack channel mention
quetzalliwrites Jun 16, 2023
769bfa3
sentence fix
quetzalliwrites Jun 16, 2023
d28c673
Merge branch 'master' into styleguide-grammar
Arya-Gupta Jun 16, 2023
ec1eadd
fixed directory structure
Arya-Gupta Jun 16, 2023
ee0a8fb
Merge branch 'styleguide-grammar' of https://github.com/Arya-Gupta/we…
Arya-Gupta Jun 16, 2023
cb41122
Merge branch 'asyncapi:master' into styleguide-grammar
Arya-Gupta Jun 30, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pages/docs/community/_section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Arya-Gupta marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions pages/docs/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Arya-Gupta marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions pages/docs/community/styleguide/_section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Arya-Gupta marked this conversation as resolved.
Show resolved Hide resolved
42 changes: 42 additions & 0 deletions pages/docs/community/styleguide/grammar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Grammar
Arya-Gupta marked this conversation as resolved.
Show resolved Hide resolved

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a paragraph introducing this Grammar document.

## Abbreviations and Acronyms
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

When using an abbreviation or acronym for the first time, spell it out and include the shortest form in parentheses.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

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 in turn 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.

Here are some examples of abbreviations:
-‘Event-driven architecture’ can be abbreviated as ‘EDA’
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved
- ‘Producer Consumer Model’ can be abbreviated as ‘PCM’
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

‘Abbreviations usually take the first few letters of a word and also end in a full-stop. On the other hand, acronyms are mostly formed from the first letter of each word in a phrase.’ - IELTS

Here are some examples of acronyms:
- ‘Artificial Intelligence’ can be acronymized as ‘AI’
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved
- ‘Application Programming Interface’ can be acronymized as ‘API’
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved


## Active voice

Prefer active voice over passive voice whenever possible. Active voice makes writing easier to read and understand. When combined with short sentences, it makes it easy to convey an idea to the reader.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

Passive: ‘The documentation is being read by Charlie.’
Active: ‘Charlie is reading the documentation.’

## Capitalization

Follow standard [capitalization rules](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for American English. Avoid using unnecessary capitalization.

Here are some examples of when capitalization should be used:
- The first letter of any sentence should be capitalized
- Trademarked words that include capital letters
- Names of programming languages or frameworks

## Spelling

Prefer American English over its counterparts. For example, use 'color' instead of 'colour'.

## Verb tense

Stick with the present tense wherever possible. However, in some cases, using the future tense might be unavoidable.
1 change: 1 addition & 0 deletions pages/docs/community/styleguide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Arya-Gupta marked this conversation as resolved.
Show resolved Hide resolved