Welcome to the AsyncAPI Documentarian Onboarding Guide!
This document aims to provide comprehensive guidelines about everything you need to know to begin your journey as a documentarian within the AsyncAPI ecosystem.
What Does a Documentarian Do?
In the community, documentarians collaborate with other documentarians, Subject Matter Experts (SME), designers, engineers, and core maintainers in doing the following:
- Create quality, easy-to-use, clear, and accurate documentation for all audience levels.
- Collaborate with other contributors to propose, create, and maintain documentation.
- Support fellow technical writers and community members.
- Engage in documentation review processes and incorporate feedback.
- Join documentation community meetings/streams to connect with the community.
Getting Started
Before you start contributing, complete the following onboarding tasks in order:
- Read the AsyncAPI Code of Conduct.
- Read the AsyncAPI Slack etiquette.
- Join the AsyncAPI Slack workspace.
- Add the AsyncAPI calendar found in the AsyncAPI events page.
- Read and familiarize yourself with the prerequisite knowledge topics.
- Familiarize yourself with the AsyncAPI Style Guide.
- Read all docs under the following content buckets:
Concepts,Tutorials,Reference. (Take the time to go through each tutorial.) - Set up your local environment following our instructions for the AsyncAPI git workflow.
- Introduce yourself in AsyncAPI Slack in the
#01_introductionschannel and the#13_docschannel. From there, ask docs-related questions. - Request a good first docs issue in the
#13_docsSlack channel. - Attend OPEN docs meetings to chat with other maintainers, ask docs questions, and request help on docs blockers.
