Skip to content

docs: grammar style guide #1827

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

Merged
merged 30 commits into from
Apr 30, 2025
Merged
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
242fd1c
docs: add gra
CBID2 Mar 27, 2025
510cb6f
docs: adding a grammar style guide
CBID2 Mar 27, 2025
fc4177f
Revert "docs: add gra"
CBID2 Mar 27, 2025
9bbd0f1
Merge branch 'master' into christine-grammar-style-guide
CBID2 Mar 27, 2025
6d62cac
feat: adding the style guide again
CBID2 Mar 27, 2025
5318909
Merge branch 'master' into christine-grammar-style-guide
CBID2 Mar 27, 2025
3bf71d2
Merge branch 'master' into christine-grammar-style-guide
thulieblack Apr 8, 2025
78d7c92
fix: improved example
CBID2 Apr 8, 2025
063d9c7
fix: improved don't example
CBID2 Apr 8, 2025
f510f0e
fix: change hyperlink
CBID2 Apr 8, 2025
04552da
fix: revised example
CBID2 Apr 8, 2025
37f94af
fix: made adjustments
CBID2 Apr 8, 2025
105ba37
fix: improve spelling
CBID2 Apr 8, 2025
df2d0ec
fix: omit hyphen
CBID2 Apr 8, 2025
b3e413b
fix: improve formatting
CBID2 Apr 8, 2025
d1a4194
fix: improve example in the personal pronoun example
CBID2 Apr 8, 2025
6f3ff1e
fix: improve formatting again
CBID2 Apr 8, 2025
0a63217
Merge branch 'master' into christine-grammar-style-guide
CBID2 Apr 13, 2025
170f830
Merge branch 'master' into christine-grammar-style-guide
thulieblack Apr 16, 2025
eb2a860
Merge branch 'master' into christine-grammar-style-guide
CBID2 Apr 17, 2025
e4306b7
Feat: Apply Thulie’s feedback
CBID2 Apr 17, 2025
376c42b
fix: omit sentence
CBID2 Apr 17, 2025
05972d3
Merge branch 'master' into christine-grammar-style-guide
CBID2 Apr 22, 2025
9138035
Merge branch 'master' into christine-grammar-style-guide
thulieblack Apr 23, 2025
2ac7836
Merge branch 'master' into christine-grammar-style-guide
CBID2 Apr 26, 2025
1aabedf
Merge branch 'master' into christine-grammar-style-guide
thulieblack Apr 29, 2025
addb58b
Merge branch 'master' into christine-grammar-style-guide
CBID2 Apr 29, 2025
98aeb29
fix: revise errors per code rabbit's suggestions
CBID2 Apr 30, 2025
1617ddf
Update grammar.md
thulieblack Apr 30, 2025
95bef4b
Merge branch 'master' into christine-grammar-style-guide
thulieblack Apr 30, 2025
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
76 changes: 76 additions & 0 deletions docs/styleguide/grammar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: Grammar
description: The style guide gives advice on how to implement grammar when creating tutorials and other forms of content for AsyncAPI.
weight: 100
---

## Abbreviations and acronyms

When using abbreviations and acronyms, write the full term followed by the acronym in parentheses. After that, use the acronym for subsequent references. Here's an example:

> An application can be a microservice, IoT (Internet of Things) device (for example, a sensor), mainframe process, and more.
> That aspect is particularly beneficial in setups like IoT, where topics are often assigned per device or device segment.

By using acronyms and abbreviations effectively, users can easily understand their context and meaning within the tutorial or guide.

## Active Voice

When writing documentation and other forms of content for AsyncAPI, use active voice whenever possible. Here's an example:

✅ **DO:** "In the context of channel addresses within AsyncAPI documents, parameters play a crucial role in defining the dynamic components of an address."

❌ **DON'T:** "In the context of channel addresses within AsyncAPI documents, the dynamic components of an address were defined by parameters."

As shown in the above sentence, active voice makes the concept more engaging and easier to understand.

## Capitalization

When capitalizing titles, headings, and certain words and terms, use the following rules:

- Capitalize the first word of a sentence.
- Capitalize the first word in a heading and title.
- Capitalize all:
- Nouns
- Pronouns
- Adjectives
- Verbs
- Adverbs
- Prepositions (in, on, at, by, for, with, to, from, of, about, through, between, among, under, over, after, before, during)
- Some subordinating conjunctions (if, unless, while, until, since, as, because, that, which, who, whom, whose, what, where, when, how, why)
- Avoid using all capital letters for emphasizing a term or concept (use italics sparingly).
- Avoid capitalizing:
- Spelled-out acronyms unless they are proper nouns (API, HTTP, URL)
- Articles (a, an, the)
- Conjunctions (and, but, or, nor, for, so, yet) unless they are part of a title or heading ("Parameters in channel address")

## Spelling

Here are some preferred spellings of certain words:

- Use "color" instead of "colour"
- Use "center" instead of "centre"
- Use "organization" instead of "organisation"
- Use "program" instead of "programme"

## Verb Tense

When writing documentation and other forms of content for AsyncAPI, use the present tense. Here's an example:

✅ **DO:** "The dynamic segment of each channel address, which corresponds to the device identifier, is then articulated through the use of parameters."

❌ **DON'T:** "The dynamic segment of each channel address, which corresponds to the device identifier, was then articulated through the use of parameters."

## Personal Pronouns

Use personal pronouns sparingly when writing tutorials and other forms of content for AsyncAPI to make them more human and approachable to users. Here's an example:

✅ **DO:** "You can add parameters to the `channel.address` by adding a parameter between curly braces like {`braces`}. Next, use `channel.parameters` to define your parameters. Finally, leverage the `components.parameters` to enable reusable parameters' definitions across multiple channels."

❌ **DON'T:** "You should add parameters to the `channel.address` by placing a parameter between curly braces like {braces}. After that, you need to use `channel.parameters` to define your parameters. Finally, you should leverage `components.parameters` to enable reusable parameters' definitions across multiple channels."

## Additional Resources

If you're looking for more information on grammar and style, consider checking out the following guides:

- [Google Style Guide](https://developers.google.com/style)
- [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
Loading