Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation📄: Add examples for Abbreviations & Acronyms #110

Open
HarshCasper opened this issue Oct 1, 2021 · 3 comments
Open

Documentation📄: Add examples for Abbreviations & Acronyms #110

HarshCasper opened this issue Oct 1, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Priority = Medium

Comments

@HarshCasper
Copy link
Member

What is the current documentation state?

Currently, we are developing our documentation style guide. While we have some recommended rules and guidelines to follow, we lack examples. This can lead to loss of accessibility around some parts that we wish to communicate with the readers. Ideally, we would like to fix it.

Where is this stated?

https://docs.moja.global/en/latest/DocumentationStyleGuide/language-grammar/abbreviations-acronymn.html

Why do you want to improve the statement?

Add 3-5 examples of DO's and DONT's as part of the style guide as a table so that it is easy for readers to review recommended examples. Take a look at the examples for Clauses here: https://docs.moja.global/en/latest/DocumentationStyleGuide/language-grammar/clauses.html

Proposed Statement

No response

Additional context.

No response

@HarshCasper HarshCasper added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Priority = Medium labels Oct 1, 2021
@SanjaySinghRajpoot
Copy link
Contributor

I would like to work on this issue.

@Sin-Sumit
Copy link

@HarshCasper I'd like to work.

@MercybirungiS
Copy link

I would like to work on this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Priority = Medium
Projects
None yet
Development

No branches or pull requests

4 participants