Skip to content

Commit 043de5e

Browse files
authored
add correct page weight
1 parent a210f41 commit 043de5e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Diff for: docs/onboarding-guide/voice-and-tone.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
22
title: "Voice and Tone"
3-
weight: 60
3+
weight: 70
44
---
55

66
## Introduction
7-
Voice and tone are essential parts of writing effective documentation for AsyncAPI. The way we write significantly impacts how our readers perceive and interact with our documentation. To help readers understand complex technical concepts and feel confident in using the AsyncAPI specification, we communicate in a clear, instructive voice and a friendly tone.
7+
Voice and tone are essential parts of writing effective documentation for AsyncAPI. How we write significantly impacts how our readers perceive and interact with our documentation. We communicate in a clear, instructive voice and a friendly tone to help readers understand complex technical concepts and feel confident in using the AsyncAPI specification.
88

99

1010
## Our Voice
1111
At AsyncAPI, we consider our voice to be:
1212

13-
- Clear and concise throughout the documentation. This way readers can get helpful information quickly even at a glance.
13+
- Clear and concise throughout the documentation. This way, readers can get helpful information quickly, even at a glance.
1414

1515
**Example**
1616
"A protocol is a set of rules that specifies how information is exchanged between applications and/or servers."
1717

18-
The above sentence uses clear and straightforward language to define what a protocol is in the context of the AsyncAPI specification.
18+
The above sentence uses clear and straightforward language to define a protocol in the context of the AsyncAPI specification.
1919

2020
- An active voice to make the documentation more engaging and easier to understand.
2121

@@ -37,7 +37,7 @@ While your voice remains constant, your tone may vary based on the audience's ne
3737
</Remember>
3838
At AsyncAPI, we consider our tone to be:
3939

40-
- Friendly and approachable that puts the reader at ease.
40+
- Friendly and approachable, which puts the reader at ease.
4141

4242
- A helpful tone that addresses the reader's concerns or questions.
4343

@@ -59,4 +59,4 @@ Here are a few key elements of writing AsyncAPI's voice:
5959

6060
- Use examples and code snippets to illustrate concepts and provide practical guidance.
6161

62-
- Use contractions to make the language more conversational e.g., "You've now added a new section called servers in your AsyncAPI document."
62+
- Use contractions to make the language more conversational, e.g., "You've now added a new section called servers in your AsyncAPI document."

0 commit comments

Comments
 (0)