The prerequisite knowledge section highlights the key technologies, concepts, and skills our technical writers need for working with AsyncAPI documentation. You must understand the main concepts behind our documentation processes, content classification, and the AsyncAPI specification.
Diátaxis framework and content buckets
AsyncAPI adopted the Diátaxis framework to meet our specific needs, classifying our documentation into content buckets (categories).
Conceptsdefine the concepts of AsyncAPI features.Tutorialsteach beginner processes with AsyncAPI by doing, taking you step-by-step from Point A to Point B.Toolsdocuments the AsyncAPI tools ecosystem.Guideteaches troubleshooting and understanding AsyncAPI's capabilities at a high level.Referencedocuments the AsyncAPI specification.Migrationguides how to upgrade to a newer AsyncAPI version.Communityexplains our documentation processes, guidelines, and resources to community members.
Markdown syntax and mermaid.js diagrams
AsyncAPI's docs are written in Markdown syntax.
Our diagrams are created with Mermaid markdown syntax thanks to the mermaid.js dependency.
AsyncAPI concepts
Before contributing to the documentation, you should understand the purpose of AsyncAPI and essential AsyncAPI concepts (i.e., servers, producers, consumers, channels, messages, etc.).
You should also fundamentally understand the AsyncAPI specification.
JSON and YAML
Because an AsyncAPI definition can be written in JSON and YAML, you must learn how to read, write, and validate these formats.
Understanding Event-Driven Architecture
Event-Driven Architecture (EDA) uses events to trigger and communicate between services. (AsyncAPI is an open-source initiative that seeks to improve the current state of EDAs.)
Protocols used with AsyncAPI
AsyncAPI supports several protocols, such as Kafka, AMQP, MQTT, and more. You will benefit from acquiring a basic understanding of protocols most used with AsyncAPI, including their use cases and how they work with AsyncAPI.
