tw editorial rewrite

asyncapi · Jan 18, 2024 · 12aa478 · 12aa478
1 parent 1cf0b30
commit 12aa478
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 14 deletions.
diff --git a/docs/onboarding-guide/docs-onboarding-checklist.md b/docs/onboarding-guide/docs-onboarding-checklist.md
@@ -1,6 +1,6 @@
 ---
 title: Docs onboarding checklist
-weight: 10
+weight: 30
 ---
 ## AsyncAPI docs onboarding checklist
 

diff --git a/docs/onboarding-guide/index.md b/docs/onboarding-guide/index.md
@@ -1,20 +1,22 @@
 ---
 title: 'Introduction'
-weight: 0
+weight: 10
 ---
-## AsyncAPI docs onboarding guide
+## Technical writer onboarding guide
 
-This onboarding guide is for technical writers who are new to the AsyncAPI community to learn how to contribute. For information about contributing to the AsyncAPI codebase, see the [contributing document](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md). Although intended for a developer audience, writers can find descriptions of general contribution principles and workflows for AsyncAPI projects.
+The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively. 
 
-The goal of this onboarding guide is to help technical writers understand the tools, technologies, and processes in our documentation. More specifically, this section will help new writers to:
+> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md).
 
-* Understand consumers of the documentation.
-* Identify teammates and subject matter experts (SMEs).
-* Find bugs and create issues.
-* Make changes to the documentation.
-* Receive feedback from reviewers.
-* Publish changes.
+The goal is providing docs contributors with the necessary tools and knowledge to:
+
+* Understand our documentation tools, technologies, and processes.
+* Comprehend our documentation target audiences.
+* Connect with teammates and subject matter experts (SMEs).
+* Report documentation bugs via issues.
+* Implement and propose updates to our documentation.
+* Obtain and incorporate reviewers' feedback.
+* Publish changes successfully.
 
-We encourage you to reach out to the community whenever you have questions. For specifics on communication channels and to move forward with onboarding, start with the [onboarding checklist](/onboarding-guide/docs-onboarding-checklist.md).
 
 
diff --git a/docs/onboarding-guide/prerequisite-knowledge.md b/docs/onboarding-guide/prerequisite-knowledge.md
@@ -1,6 +1,6 @@
 ---
 title: 'Prerequisite knowledge'
-weight: 20
+weight: 40
 ---
 
 This section highlights the key technologies, concepts, and skills that technical writers should know when working on AsyncAPI documentation. While you don't need to know everything to begin contributing, you should understand the main concepts behind the documentation methodology and tools, as well as the technologies surrounding the AsyncAPI specification.

diff --git a/docs/onboarding-guide/technical-writer-contributor-responsibilities.md b/docs/onboarding-guide/technical-writer-contributor-responsibilities.md
@@ -1,6 +1,6 @@
 ---
 title: 'Technical writer contributor responsibilities'
-weight: 30
+weight: 20
 ---
 
 Technical writers will collaborate with other writers, SMEs, designers, developers, and maintainers to create quality technical documentation.