Introduction

Found an error? Have a suggestion?Edit this page on GitHub

Technical writer onboarding guide

The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively.

For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../community/ 010-contribution-guidelines)

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.
Was this helpful?
Help us improve the docs by adding your contribution.
OR
Github:AsyncAPICreate Issue on GitHub