docs: new style guide - Glossary

[quetzalliwrites]

Let's finally get around to creating, designing, and incorporating an AsyncAPI Style Guide!

Why the need?

In tech jobs, we often focus on our technology's technical aspects, such as functionality and performance. However, the documentation for our technology is equally important to the code itself. A style guide ensures consistency and clarity, establishes a consistent voice and tone in your documentation, makes it easier for multiple writers to work together on a single doc, and helps ensure documentation is accurate and up-to-date. When all of your technical writers follow the same guidelines, it's easier for readers to find the information they need and understand how to use your product or OSS technology.

What section of the AsyncAPI Style Guide is this issue for?

• Glossary: A glossary can help to ensure consistency in the use of terminology throughout your documentation, which can improve clarity and comprehension for readers. The guidelines can include instructions on the types of terms to include, how to define and format them, and how to maintain and update the glossary over time. (Source: OpenAI's ChatGPT)

Where should this go?

Let's create a new .md file for only the Glossary section of the new AsyncAPI Style Guide.

Create the following directory and place your file there: asyncapi.com/docs/community/styleguide/glossary.md.

Extra Resources

• Write the Docs: Style Guides
• Gatsby Style Guide
• Gatsby Docs Structure & Documentation Types
• Mozilla Style Guide
• Google Style Guide
• Microsoft Style Guide

[octonawish-akcodes]

Can I take this one

[quetzalliwrites]

heyo! we'll assign this task once we've completed the previous ones so we get it done in order... glad we already synced via DM slack too ✌🏽😄

[CynthiaPeter]

Adding this discussion link shared by @derberg.

[rukundob451]

Adding this discussion link shared by @derberg.

Sure sure, we do.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart: