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

(#794) Add Jargon Buster page #795

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pauby
Copy link
Member

@pauby pauby commented Jul 21, 2023

Description Of Changes

Adds the start of a Jargon Buster page.

Motivation and Context

Our documentation uses jargon and acronyms that we need to bust!

Testing

  • I have previewed these changes using the Docker Container or another method before submitting this pull request.

Change Types Made

  • Minor documentation fix (typos etc.).
  • Major documentation change (refactoring, reformatting or adding documentation to existing page).
  • New documentation page added.
  • The change I have made should have a video added, and I have raised an issue for this.
    • Issue #

Change Checklist

  • Requires a change to menu structure (top or left hand side)/
  • Menu structure has been updated

Related Issue

Fixes #794

@pauby
Copy link
Member Author

pauby commented Jul 21, 2023

@gep13 @AdmiringWorm @vexx32 @corbob @st3phhays @Windos @ryanrichter94 @imm0rtalsupp0rt @JPRuskin I've tagged you all in this to review and suggest additions.

Note that this is not in any way complete. I want to get the obvious ones in here and we can update as we go along. Let me know of any, and their definitions and we can add them.

Copy link
Member

@corbob corbob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how I feel about using the term "jargon" in the title and the url. I'm thinking for people searching for it, what might they look for? At the very least, we should possibly include the term glossary somewhere.

input/en-us/information/jargon-buster.md Outdated Show resolved Hide resolved
input/en-us/information/jargon-buster.md Outdated Show resolved Hide resolved
input/en-us/information/jargon-buster.md Outdated Show resolved Hide resolved
@pauby
Copy link
Member Author

pauby commented Jul 21, 2023

I don't feel the word glossary is useful here. A glossary, to me, is a place where I can go and look up all word I don't know that are in the document I'm reading. This is only a page listing jargon and acronyms. It's not a glossary about what a network card is, or a terminal etc.

I feel that jargon buster (which is a commonly used phrase and many documents, technical and not, use them) is a good description of what this is.

@pauby pauby force-pushed the doc/add-jargon-buster branch from 705d4fd to a79e59e Compare July 21, 2023 16:12
@@ -0,0 +1,39 @@
---
Order: 60
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

learning-resources/index.md is already order level 60. Assuming we want this before "More Learning Resources" we should probably set this to 55.

### N

* **NuGet**. Refers to the tool and framework used to install [NuGet packages](https://nuget.org). The Chocolatey packaging framework is based on the NuGet packaging framework.
* **nupkg**. A Chocolatey package file has the extension `nupkg` and this is a shorthand term referring to the package file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If nupkg is here, nuspec would probably also be worthwhile to have.

@gep13
Copy link
Member

gep13 commented Jul 24, 2023

It has been mentioned elsewhere, but capturing here as well, can we add CLE to the list?

Also, do we want the reciprocal entry for package? In the nupkg entry, we mention that this is a Chocolatey package, so in the package entry, we would mention that this is a file that ends with *.nupkg.

Order: 60
xref: jargon-buster
Title: Jargon Buster
Description: A reference guide on the jargon and acronyms used in our documentation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Description: A reference guide on the jargon and acronyms used in our documentation.
Description: A reference guide on the jargon and acronyms used in our documentation

None of our other Descriptions contain a . at the end. I noticed that there was an inconsistency in this area recently, and I made them the same. The overwhelming majority of our pages didn't have a ..

Copy link
Member

@vexx32 vexx32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple minor grammatical nits that read a bit funny to me, but otherwise I think this looks good so far :3


While a goal for our documentation is clarity we recognize that as engineers and technical users of our software, we speak and write in a manner that may not always be as clear to others as we would like.

One of our goals for writing documentation, is clarity. As we update our documentation we strive to bring clarity to it. But this is a work in-progress. We recognize that jargon and acronyms can cause confusion, misunderstanding and act as a barrier for those who are getting started with our software.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
One of our goals for writing documentation, is clarity. As we update our documentation we strive to bring clarity to it. But this is a work in-progress. We recognize that jargon and acronyms can cause confusion, misunderstanding and act as a barrier for those who are getting started with our software.
One of our goals for writing documentation, is clarity. As we update our documentation we strive to bring clarity to it, but this is a work in-progress. We recognize that jargon and acronyms can cause confusion, misunderstanding and act as a barrier for those who are getting started with our software.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The end of the sentence there was deliberate. As it emphasises the But in the next sentence.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I'm aware most style guides would say you shouldn't splice a sentence like that. Personally I don't think it helps the clarity for the reader, but it's not a huge issue either. 🤷‍♀️

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can point me to a style guide, I'm happy to review it. I use LanguageTool (as I said) so I tend to rely on that as the source of truth.

input/en-us/information/jargon-buster.md Show resolved Hide resolved
@pauby pauby force-pushed the doc/add-jargon-buster branch from a79e59e to 118d694 Compare August 4, 2023 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a Jargon Buster page
5 participants