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.

Sign up for GitHub

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

Jump to bottom

(#794) Add Jargon Buster page #795

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

(#794) Add Jargon Buster page #795

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99a2070
(#794) Add Jargon Buster page
pauby Jul 21, 2023
118d694
rebase
pauby Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions input/en-us/information/jargon-buster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
Order: 55
xref: jargon-buster
Title: Jargon Buster
Description: A reference guide on the jargon and acronyms used in our documentation
---

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.


This guide aims to define the common jargon and acronyms used in our documentation. It contains both Chocolatey specific, and more general computer jargon and acronyms.
pauby marked this conversation as resolved.
Show resolved Hide resolved

If you feel a definition is missing, unclear or could be better, please raise an issue on our [Documentation GitHub repository](https://github.com/chocolatey/docs).

## Jargon Busted. Acronyms Defined.

### A

* **AV**. Shorthand term for 'antivirus'. Commonly used in phrases such as 'AV software' or 'AV detections'.

### C

* **CCM**. A shorthand term for [Chocolatey Central Management](xref:central-management).
* **CCR**. Shorthands for [Chocolatey Community Repository](https://community.chocolatey.org). This is the repository that hosts community maintained Chocolatey packages.
* **Central Management**. Another shorthand term used to mean [Chocolatey Central Management](xref:central-management).
* **choco**. This is a commonly used shorthand term for [Chocolatey CLI](aref:choco) or more specifically, the Chocolatey CLI command run from the command line. For example, to install a package you would use `choco install <PACKAGE>`.
* **Chocolatey**. This is another commonly used term to refer to [Chocolatey CLI](xref:choco). It is also commonly used to refer to the Chocolatey suite of products as a whole. We now try to be clearer by referring to Chocolatey CLI specifically when we need to.
* **CLI**. This is shorthand for [Command Line Interface](https://en.wikipedia.org/wiki/Command-line_interface) and refers to interacting with an application from a terminal by typing commands.

### M

* **metadata**.

### 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.

* **nuspec**. A Chocolatey package file that has the extension `nuspec`. This file contains the package metadata.

### V

* **VirusTotal**. A service that scans submitted files against over [70 antivirus scanners and URL / blocklisting services](https://support.virustotal.com/hc/en-us/articles/115002126889-How-it-works). The [VirusTotal](https://virustotal.com) results for each Chocolatey Community Repository package are shown under the Virus Scan Results section.
* **VT**. Shorthand for [VirusTotal](https://virustotal.com). See the definition for VirusTotal.
Loading