website
website copied to clipboard
asyncapi
docs: new style guide - Inclusive language
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?
- Inclusive language: Inclusive language enables everyone in your organization to feel valued, respected, and able to contribute their talents.
Some examples:
- main v.s. master
- allowlist/denylist v.s. whitelist/blacklist
- placeholder data v.s. dummy data
- gender-neutral (EX: they/them v.s. he/him)
Where should this go?
Let's create a new .md file for only the Inclusive language section of the new AsyncAPI Style Guide.
Create the following directory and place your file there: asyncapi.com/docs/community/styleguide/inclusive-language.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
Hello @alequetzalli Do we need to create a "community" folder under this directory and then add "styleguide" within it? https://github.com/asyncapi/website/tree/master/pages/docs
for now yeah! we have decide differently later on the folder but for now that is the plan :D
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:
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hey there @BhaswatiRoy, are you saying that you're adding more to this PR? (wanted to make sure I understood your comment) 😄
Either way, I am going to make another editorial round on it this week again :)
Hey there @BhaswatiRoy, are you saying that you're adding more to this PR? (wanted to make sure I understood your comment) 😄
Either way, I am going to make another editorial round on it this week again :)
hello, I commented so that the bot doesn't mark it as closed :sweat_smile:
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:
Just reviewed the PR resolving the issue In context, Issue will be closed soon once the PR is merged.
