Source: https://developers.google.com/style/jargon\n\n# Jargon
Stay organized with collections
Save and categorize content based on your preferences.\n\n- Home\n- Products\n- Style\n\n\n## Page Summary\n\n- Jargon, while common in specific groups, can hinder clear communication, especially for global or diverse audiences.\n- When possible, avoid or replace jargon with plain language for better clarity and inclusivity.\n- If jargon is necessary (e.g., for SEO), define it clearly on first use or link to a trusted definition.\n- Prioritize clear communication over using specialized terminology that may not be widely understood.\n\nJargon, while common in specific groups, can hinder clear communication, especially for global or diverse audiences.\n\nWhen possible, avoid or replace jargon with plain language for better clarity and inclusivity.\n\nIf jargon is necessary (e.g., for SEO), define it clearly on first use or link to a trusted definition.\n\nPrioritize clear communication over using specialized terminology that may not be widely understood.\n\nJargon is the specialized and often figurative terminology of a specific group to represent a
larger concept—for example, camel case, swim lane,
break-glass procedure, or out-of-the-box. Jargon can also include
vaguely defined or overloaded terms like solution, support, or
workload.\n\nTypically, the meaning of jargon isn't understood except by the specific group. For this reason,
jargon can hamper our efforts to publish content that's clear, that reaches a
global audience
in multiple languages, that serves readers at various levels of product knowledge, and that's
inclusive of different groups and cultures. For more information about writing with
inclusivity and diversity in mind, see
Write inclusive documentation.\n\nHowever, some jargon is widely understood and accepted by our industry or by the intended
audience of a document. It can be valuable to include jargon in a document when you know that
readers search for those terms. If you're going to use jargon, consider the following questions:\n\n- Can you write around the term? If you don't need the term for search engine
optimization (SEO), try writing around it. For example, instead of writing Hold a
post-mortem, write When the project is finished, review what processes worked or didn't
work. Instead of writing Create a back-of-the-envelope design, write Use an informal
design process.\n- Can you replace the term with a different, more specific term? For example, the
word list
for this style guide offers several replacement terms: affected area or spatial
impact (for blast radius), import or load (for ingest), and
ready-made or pre-built (for off-the-shelf). When a term on the word list is
marked as "Don't use" (some jargon can be considered offensive, violent, or not inclusive),
replace that term or write around it.\n- Are you using the term only once in your document? If so, describe the term in plain
language and refer to it in parentheses, or link to a trusted definition.
Recommended: You then move the task to an
earlier part of the process (also known as shifting left).
Recommended: A
split-brain
situation can develop.\n- Are you using the term throughout your document? If so, briefly describe the term in
parentheses on first reference, or link to a trusted definition.
Recommended: The application is in the
same state as a cold standby (a backup or redundant system that's identical to a primary
system).
Recommended: A better approach is to use
a pattern called a
dead letter queue.\n- Is the term used in a command or code sample? If so, use the words only in direct reference to the code items
(formatted as code), and make it clear
what you're referring to.
Recommended: Add a user to the
allowlist (whitelist) by entering the following:
whitelist adduser EMAIL_ADDRESS.
Not recommended: Add a user to the
whitelist by entering the following: whitelist adduser
EMAIL_ADDRESS.\n\nRecommended: You then move the task to an
earlier part of the process (also known as shifting left).\n\nRecommended: A
split-brain
situation can develop.\n\nRecommended: The application is in the
same state as a cold standby (a backup or redundant system that's identical to a primary
system).\n\nRecommended: A better approach is to use
a pattern called a
dead letter queue.\n\nIs the term used in a command or code sample? If so, use the words only in direct reference to the code items
(formatted as code), and make it clear
what you're referring to.\n\nRecommended: Add a user to the
allowlist (whitelist) by entering the following:
whitelist adduser EMAIL_ADDRESS.\n\nNot recommended: Add a user to the
whitelist by entering the following: whitelist adduser
EMAIL_ADDRESS.\n