Jargon are special words or phrases used by a particular group and are often difficult for those outside of the group to understand. Jargon can be tricky. There are no hard and fast rules; much depends on the audience. When creating knowledge, communications, or web content, always assume novice exposure to relevant topics.
Avoid jargon as much as possible, and replace any overly technical language with plain language alternatives. When addressing users directly, avoid referring to them as "users" and instead say "you."
For example, instead of "Users may see updates to the application's user-interface," say "You may notice some changes to the way the home page looks once you've signed in." A good question to ask yourself is, "If someone who doesn't work in IT reads this, would they understand?"
Additionally, avoid using acronyms when possible. If they are needed, refer to Define Acronyms.
Additional Considerations for Comms
None
Additional Considerations for Knowledge
-
When creating an internal knowledge article, you have more latitude to use technical terms.
-
However, not everyone has the same level of expertise with every technology. Avoid using jargon unless absolutely necessary.
-
- If the jargon is an acronym, define acronyms and abbreviations on first use. Refer to Define Acronyms.
Additional Considerations for Website Content
None