chaoss
Limiting the use of acronyms/abbreviations across board on chaoss spaces
Summary
Limiting the use of complex acronyms/abbreviations to where technically necessary across all chaoss webpages, repositories, meeting minutes, Documentation, Google docs, spreadsheets and the standard naming convention document.
Background
For clarity; considering newcomers, open source enthusiasts and for posterity sake. Abiding by the "keep it stupid simple" (KISS) design principle.
Details
I recommend this be implemented across board, on the website, GIT repositories, Google docs and spreadsheets and also on the naming convention template for future records.
Outcome
Enabling new and incoming contributors have an easier experience reading, understanding and participating in chaoss documentation and work flow and at large, our great community.
Hi @FeazUI thank you for opening this issue. Could you point to some examples of this
I chatted with @FeazUI a little earlier about this - here was an example he sent me. Not everyone knows what OSS is right off the bat, for instance.
@FeazUI has agreed to work on this issue and provide links to external resources or provide an explanation of acronyms that are confusing for newcomers. 👍
@FeazUI I'm going to move this to the community repository since that's where most of these documents live. If you make a list of the pages that need some attention, I can point you to the places where they can be fixed.
The use of CHAOSS under the header “welcome” should be expanded in full form as an introduction on the first page into the chaoss world.
Also the use of DEI event badging program acronym in the “finding your way” header, number three.
https://github.com/chaoss
The Use of PR as an acronym here. Typo in the spelling of “Confirming” in second paragraph.
https://github.com/chaoss/community/blob/main/how-to-contribute/DCOsetup.md
The Use of the Ospo acronym under “Types of Working groups”.
https://github.com/chaoss/community/blob/main/community-initiatives-and-working-groups/Working-Groups/README.md
I think we should excalate this terminology-usage.md document, expanded upon and set on front stage. (Pinned to chaoss GitHub repo) So it can be a guiding handbook/ recommended read for chaotics.
https://github.com/chaoss/community/blob/main/community-resources/terminology/terminology-usage.md
@FeazUI would you feel comfortable submitting PRs for these changes to these files?
@FeazUI I was also wondering if it would be helpful to surface these documents on CHAOSS terminology a little better. We have the repo https://github.com/chaoss/community/tree/main/community-resources/terminology but also on the website https://chaoss.community/kbtopic/terminology/. (the website pulls directly from GitHub)
Is there a better way we can make this information discoverable?
Definitely @ElizabethN, its a well researched document... terminology.md, we could add a comprehensive list of “everyday chatter” technical terms to the document and pin it front stage on the CHAOSS main repo.
This process will of course be open to contributions from all chaotics and peer reviewed there after on a google doc.
Hi @FeazUI -- could you provide a few pull requests to suggest some changes that you are mentioning here? I think this is really great, so thanks for the input.
Hello @germonprez, Over time, our great organization has organically implemented those changes to make markdown documents more readable & understandable especially for new chaotics...by way of reducing acronyms (shorthand, initials) and extremely technical terms. I will however create a Pull Request for new Markdown documents I think needs a review or some changes
Cheers!
I'm going to go ahead and close this, only because it's really old, and this seems like an ongoing maintenance kind of issue 😄. Happy to merge in any PRs you create to cut down on the abbreviations, @FeazUI!