- Use Ctrl + F to search this page for guidance on specific words.
- Words shown in brackets
[ ]
are optional. - For the correct spelling of third-party technologies and product names, see Dynatrace Supported Technologies.
- For general writing guidelines and guidance on words that aren't included in this list, see the Microsoft Style Guide. For questions that aren't addressed by Microsoft Style, see The American Heritage Dictionary or the Chicago Manual of Style. For language questions that aren't included in this list or the resources listed above, search the web to identify commonly accepted phrasing and terminology.
- Tips for writing for international audiences
- Use simple words and concise sentences. Make every word count. Concise, clear sentences save space, are easy to understand, and facilitate scanning.
[The] Dynatrace Software Intelligence Platform
✔️ The Dynatrace Software Intelligence Platform is comprehensive.
✔️ The Dynatrace platform is comprehensive.
Dynatrace solutions (aka modules)
-
[Dynatrace] Infrastructure Monitoring
-
[Dynatrace] Application Security
-
[Dynatrace] Applications & Microservices
-
[Dynatrace] Cloud Automation
-
[Dynatrace] Business Analytics
-
[Dynatrace] Digital Experience [Monitoring] (DEM)
❌ Digital Experience "Management"
-
[Dynatrace] Infrastructure Monitoring
❌ "Infrastructure-only" monitoring
Dynatrace deployment options
- Dynatrace Managed
- Dynatrace Managed Offline
- Dynatrace SaaS
Dynatrace product capabilities
Dynatrace Price Book line items
- Acceleration Services
- Architect Services
- [Dynatrace] Autonomous Cloud Enablement (ACE)
- [Business] Insights [Assessment]
- Consultant Services
- Custom Extension Services
- [Dynatrace] Application and Infrastructure Monitoring
- Dynatrace Education Services
- [Dynatrace] [ACE] Services
- Dynatrace Extension Support Plan
- [Dynatrace] Full-Stack Monitoring
- Dynatrace for Government
- Dynatrace Mainframe
- Dynatrace Managed [Offline mode]
- [Dynatrace Managed] Mission Control Support Services (aka Dynatrace Mission Control)
- Dynatrace ONE Premium
- Guardian Services
- Log Monitoring
- Premium High Availability [add-on]
- [OneAgent] Full-Stack Monitoring mode
- [OneAgent] Infrastructure Monitoring mode
- Real User Monitoring
- Session Replay
- Synthetic Monitoring
Dynatrace monitoring-consumption units
- DEM units
- Davis data units (DDUs)
- Flexpoints
- host units
- host unit hours
- metric data points
Dynatrace technologies and features
[Cluster | Environment] ActiveGate
✔️ You need to install an Environment ActiveGate.
✔️ You need to install a Cluster ActiveGate.
✔️ The Environment ActiveGate sends data to the Managed Cluster.
❌ Install "Activegate."
add-on
✔️ Install the Premium High Availability add-on.
❌ Install the Premium High Availability "addon,"
❌ Install the Premium High Availability "plugin,"
browser monitors
✔️ single-URL browser monitor
✔️ browser clickpath
❌ "browser clickpath monitor"
See clickpath.
custom metrics
Data explorer
✔️ To access the Data explorer, in the Dynatrace menu, go to Explore data.
❌ "Explorer"
Davis Assistant
No registered trademark symbol required.
✔️ You can interact with Davis Assistant via Slack.
✔️ Meet Davis Assistant.
❌ You can interact with "Davis A" via Slack.
[Dynatrace] OneAgent®
Dynatrace provides a single agent: OneAgent. Precede with "the" only when referring to a single instance of OneAgent. Otherwise, "the" should not be included.
✔️ OneAgent
✔️ Dynatrace OneAgent
✔️ OneAgent PHP module
❌ "the" Dynatrace OneAgent
❌ "PHP agent," "process agent," "Java agent," "network agent," "OS agent," "mainframe agent," "database agent"
Also see Registered trademarks.
[Dynatrace] Davis® [event-driven] [AI causation engine]
✔️ Dependencies are analyzed by Davis®, the Dynatrace AI causation engine.
✔️ Dynatrace Davis
❌ "DAVIS"
❌ "davis"
Also see Registered trademarks.
[Dynatrace] Documentation
The name of the Dynatrace help system is Dynatrace Documentation.
Provide links to Dynatrace Documentation topics wherever further product detail will add value to your content. Anticipate where in your content users might have questions and add links to specific Documentation topics there. Don't use vague suggestions like "consult the help" or "see documentation."
✔️ For details, see <Topic title> in Dynatrace Documentation.
✔️ For details on <a topic>, see <Documentation topic title>. (Note that topic titles in link texts can be edited or consolidated for readability.)
✔️ For details on configuring <Third-Party Product Name>, see <Third-Party Product Name> documentation.
✔️ ...listed on the right side of every topic in Dynatrace Documentation.
❌ "See Dynatrace Documentation." (Include links to specific topics with meaningful link text.)
❌ Go to "Dynatrace Help." (The name of our documentation system is Dynatrace Documentation.)
❌ For details, consult "the documentation."
[the Dynatrace] timeframe selector
✔️ [the Dynatrace] timeframe selector
❌ "Global time selector"
❌ "global timeframe selector"
❌ "The Timeframe Selector"
❌ "time picker"
[Dynatrace] Hub
This is the in-product, environment-specific list of Dynatrace extensions that's available in the Manage section of Dynatrace menu at Hub. This is where users download, install, and update extensions that are relevant to their technology stack and Dynatrace environment.
✔️ To download and install OneAgent, in the Dynatrace menu, go to Hub.
❌ To download and install OneAgent, go to "the Dynatrace software intelligence Hub."
Note that the Software Intelligence Hub, https://www.dynatrace.com/hub/, is the publicly available generalized version of the in-product Hub catalog and serves a Marketing purpose only. This Marketing webpage has no connection to the user's Dynatrace environment or awareness of their technology stack. To refer users to downloads and activation instructions, direct them to the in-product Dynatrace Hub; do not use "the Software Intelligence Hub" or direct them to https://www.dynatrace.com/hub
.
Dynatrace [ONE] Product Specialist
✔️ To contact a Dynatrace ONE Product Specialist, select Chat on the menu bar.
❌ To contact "D1," select Chat on the menu bar.
Dynatrace Cluster, cluster
✔️ Updates are rolled out to each Dynatrace Cluster.
✔️ The cluster was updated yesterday. (Lowercase "cluster" works for generic references to either a Dynatrace Cluster or a third-party server cluster.)
❌ Updates are rolled out to each "Dynatrace Server."
❌ Updates are rolled out to each "Dynatrace cluster."
Dynatrace Operator
This term will replace the existing "OneAgent Operator" component in the near future.
Dynatrace web UI
✔️ The functionality is available via both the Dynatrace web UI and the API.
❌ The functionality is available via both the "Dynatrace interface" and the API.
Dynatrace menu
This is the menu that appears on the left side of the Dynatrace web UI. Omit group labels such as Infrastructure when pointing to top-level items in the Dynatrace menu.
✔️ In the Dynatrace menu, go to Synthetic. (Preferred for referring to top-level items in the Dynatrace menu.)
✔️ From the Dynatrace menu, go to Settings > Web and mobile monitoring > User experience score. (Appropriate when the Dynatrace menu serves as the starting point of a path through the web UI.)
✔️ Select Frontend from the Dynatrace menu.
✔️ From the Dynatrace menu, select Frontend.
❌ Go to Frontend in "the menu."
❌ Select Frontend from the "navigation menu."
[built-in, custom, or custom remote] extensions
✔️ OneAgent extensions
✔️ ActiveGate extensions
❌ Dynatrace "plugins"
See Dynatrace extensions.
Hyperlyzer®
Also see Registered trademarks.
Keptn
Pronounced "Captain."
✔️ Keptn
❌ "keptn"
PurePath®
Also see Registered trademarks.
Smartscape®
✔️ Smartscape
❌ "smartscape"
❌ "SmartScape"
Also see Registered trademarks.
management zones
network zones
Frequently used words
AIOps
adjust
✔️ You can adjust the settings later if they're not set correctly.
❌ You can "configure" the settings later if they're not set correctly.
❌ Your success depends on how you "adjust" your environment and workflows.
affect, effect
✔️ This might affect performance.
✔️ The change affects everyone.
✔️ This might have an effect on performance.
✔️ The effects of the changes were dramatic.
after
Use after in place of "once."
✔️ After you install the software, you can adjust the settings.
❌ "Once" you install the software, you can adjust the settings.
agent
As a general rule, avoid the word "agent." Use OneAgent instead.
✔️ OneAgent
✔️ OneAgent for Mobile
✔️ user agent
❌ "PHP agent," "JavaScript agent," "Mainframe Agent," "OS agent"
Also see RUM JavaScript.
AI, AIOps
✔️ AI
✔️ AIOps
✔️ artificial intelligence
✔️ artificial intelligence for IT operations
See Dynatrace AIOps and Davis AI causation engine.
although
Use although in place of "while."
✔️ Although many monitoring tools are available, only Dynatrace leverages AI.
❌ "While" many monitoring tools are available, only Dynatrace leverages AI.
❌ "While" proper planning takes time, it's worth the effort.
Also see while.
and
Avoid using an ampersand ("&") in place of and except where necessary due to space limitations or when specifically needed as a design element.
✔️ Support and services
❌ Support "&" services
❌ Support "and/or" services
app, application
- As a general guideline, use app when referring to a mobile app or a small application that runs on a platform.
- Use application when referring to a web or other application type.
Application Performance Management (APM)
✔️ Application Performance Management
❌ Application Performance "Monitoring"
autodiscovery
❌ "auto-discovery"
backward compatible
✔️ This release is backward compatible with previous releases.
✔️ This is a backward-compatible release.
❌ "backwards" compatible
because
Use because when modifying a verb; use due to when modifying a noun.
✔️ The monitor failed because the credentials were invalid.
✔️ Monitor failure was due to invalid credentials.
Use because in place of "since" to denote causality.
✔️ The data was lost because the settings are incorrect.
❌ The data was lost "since" the settings are incorrect.
❌ Performance improved "since" the error was fixed.
BizDevOps
BOSH
✔️ BOSH release
button
- Use select, not "click" when describing interaction with the product UI.
- Mention the control label (the name of the control); avoid mentioning the word "button" wherever possible.
✔️ Select Install now.
❌ Select "the Install now button."
can, may, might
Use can to express ability and use might (not "may") to express possibility. Use may only if you are speaking of providing permission.
✔️ You can install the software.
✔️ The system might fail.
✔️ You might encounter errors.
✔️ You may now proceed with the installation.
❌ You "may" install the software.
❌ You "may" encounter errors.
❌ It "may" happen that errors occur.
❌ Errors "may" occur.
can't, don't, won't
While contractions should be used whenever possible because they mimic conversational speech (for example, I'll, you'll, they're, and we're). Negative contractions (for example, can't, don't, and won't) are acceptable but, sometimes, can reduce comprehension by some international audiences. For imperative statements or caveats in documentation, it's acceptable to say, for example, do not in place of "don't".
✔️ You don't want to waste time.
✔️ You can't open the file or delete it.
✔️ It won't affect performance.
✔️ Do not use a proxy when communicating with these hosts.
✔️ JavaScript errors do not lead to monitor failure.
❌ "musn’t" or "shan’t"
checkbox
✔️ checkbox
❌ "check box"
- Mention the control label; avoid mentioning the term checkbox where possible.
- Use select and clear with checkboxes, not "turn on" and "turn off," "mark" and "unmark," "check" and "uncheck," or "select" and "deselect."
✔️ Select Restart.
✔️ Clear Restart.
❌ "Deselect" the Restart checkbox.
❌ "Check" Restart.
❌ "Uncheck" Restart.
click, select
Use click only when referring to mouse actions. Otherwise, use select, which works for all device types.
✔️ Select <button label>.
✔️ Select <checkbox label>.
✔️ Select <radio button label>.
✔️ Right-click <button label>.
✔️ Double-click <button label>.
✔️ Hover over the image and click with your mouse.
✔️ Select <button label> on your mobile device.
❌ "Click" <button label> on your mobile device.
clickpath
✔️ clickpath
❌ "click path"
See browser monitors.
cloud
✔️ cloud (lowercase for general statements: cloud components, cloud monitoring, cloud infrastructure)
✔️ Cloud (uppercase when used in a product name such as SAP Cloud Platform or Cloud Foundry)
command line, command-line
Linux users enter commands on a command line. Windows users enter commands at a command prompt, not "on a command line."
✔️ command-line parameter
✔️ command-line tool
✔️ command line interface (CLI)
✔️ On the Linux command line, enter <command>
.
❌ "On the Microsoft command line," enter <command>
.
command prompt
This is a command prompt: C:>
.
Windows users enter commands at a command prompt, not "on a command line." Linux users enter commands on a command line.
✔️ At the command prompt, enter <command>
.
✔️ At the Windows command prompt, enter <command>
.
✔️ In Windows, open the Command Prompt.
❌ "At the Linux command prompt," enter <command>
.
configure
✔️ Your success depends on how you configure your environment and workflows.
❌ You can "configure" the settings later if they're not set correctly.
container
container orchestration
containerization
data
✔️ The data is overwhelming.
✔️ There is less data on current trends.
❌ The "data are" overwhelming.
❌ There "are fewer data."
Also see Format Units for details on writing units of data (bytes, bits, and more).
data center
✔️ data center
❌ "datacenter"
❌ "DC"
deploy, redeploy
✔️ deploy
✔️ redeploy
❌ "re-deploy"
DevOps
Short for "Development + Operations"
✔️ DevOps
❌ "devops"
digital transformation
Docker, Dockerized
Dynatrace®
✔️ Dynatrace OneAgent
✔️ We are Dynatracers.
❌ "dynatrace"
❌ "dynaTrace"
❌ "Dynatrace's" OneAgent (Do not add 's
to create the possessive form.)
Also see Registered trademarks.
Early Adopter release
✔️ Feature X is now available as an Early Adopter release.
✔️ Feature X is now available in an Early Adopter release.
✔️ EA (abbreviation when space is limited)
❌ "EAR"
❌ Early Adopter "Release"
❌ Early "adopter" release
See Previews and Early Adopter releases for details.
✔️ email
❌ "e-mail"
❌ "E-mail"
❌ "Email"
environment, tenant
Use Dynatrace "environment when referring to the environment in which Dynatrace users perform data analysis and interact with Dynatrace. Use tenant only when referring to the physical space on a server where software is hosted.
✔️ Set up your Dynatrace environment with custom dashboards, email notifications, and more.
✔️ Log in to your Dynatrace OpenShift environment.
❌ Set up your Dynatrace "tenant" with custom dashboards, email notifications, and more.
example, for example
✔️ For example, if you...
✔️ This could be useful when, for example, you have...
✔️ Example 1:
✔️ In this example,...
❌ "..., e.g.,..."
See such as, for example, including.
[Dynatrace] extension
Dynatrace issues OneAgent and ActiveGate extensions. Use plugin only when referring to third-party products, such as a browser plugin or Dynatrace plugins in a third-party store for an application we integrate with.
✔️ extension
✔️ OneAgent extension
✔️ ActiveGate extension
✔️ Dynatrace Extension SDK
❌ OneAgent "plug-in" or "plugin"
❌ ActiveGate "plug-in" or "plugin"
file format extensions
When referring to a file by its extension type, write, for example, ZIP, JSON, PDF, XLS, or MD.
✔️ Download the ZIP file.
✔️ Upload the JSON file.
✔️ Download file.zip
to your local machine.
❌ Download the ".zip" file.
❌ Download the "json."
[Dynatrace] Full-Stack Monitoring [mode]
The phrase full stack (without a hyphen) is widely accepted and can be used when referring to generic full stack monitoring. A hyphen is required when this phrase is used as a descriptor, as in Full-Stack Monitoring mode.
✔️ Dynatrace Full-Stack Monitoring
✔️ Set OneAgent to Full-Stack Monitoring mode.
✔️ Other vendors also provide full stack monitoring.
General Availability (GA) release
See details regarding GA, Preview, and Early Adopter releases.
✔️ The General Availability release will be included with Dynatrace version 1.199.
✔️ The new filters will reach GA in March 2020.
✔️ Dynatrace version 1.219 is now generally available.
❌ The new filters "go GA" in March 2020.
❌ General Availability "Release"
gathers
Where appropriate, use gathers rather than "aggregates" for a less formal tone.
✔️ OneAgent gathers monitoring data from each monitored host.
❌ OneAgent "aggregates" monitoring data from each monitored host.
have to, need to, must
See need to.
however
However is typically followed by a comma (,
).
✔️ It's usually fast and reliable. However, if you have...
✔️ In some cases, however, the...
hyperscale
ID
Abbreviation of identifier
✔️ ID
❌ "Id" or "id"
Identity and Access Management (IAM)
Pronounced "I am" or "I.A.M."
✔️ Identity and Access Management
✔️ IAM
Infrastructure as a Service (IaaS)
installer
✔️ Run the installer.
❌ Run the "executable."
internet
✔️ Search the internet.
❌ Search the "Internet."
it's
Short for "it is"—do not use to indicate possessive case.
✔️ It's easier to learn this way.
❌ "It is" easier to learn this way.
❌ Each instance has "it's" own identifier.
Java
✔️ Java
❌ "java"
JavaScript
✔️ RUM JavaScript
❌ "javascript"
❌ "Javascript"
❌ "JS"
Also see RUM JavaScript.
left, right, upper, lower
✔️ lower left
✔️ lower right
✔️ upper left
✔️ upper right
✔️ lower-left corner
✔️ upper-right corner
✔️ leftmost
✔️ on the left side
✔️ rightmost
✔️ on the right side
✔️ the System menu on the left side of the page
✔️ the User menu in the upper-right corner of the page
❌ "left-hand" side
❌ "right-hand" corner
❌ "bottom left"
❌ "bottom right"
❌ "top left"
❌ "top right"
❌ "far-left"
❌ "far-right"
❌ "at the top of the page," "at the bottom of the page"
less, fewer
When comparing quantities:
- Use less to refer to an amount, value, or degree.
- Use fewer to refer to a countable number of items.
- Don't use "under" to refer to a quantity or number.
✔️ Create an app in less than five minutes.
✔️ The new building has less floor space and contains fewer offices.
✔️ The new building has fewer square feet of floor space and contains fewer offices.
✔️ Fewer than 75 members were present.
✔️ Less than a quorum attended.
❌ Create an app in "under" five minutes.
See the Microsoft Style Guide.
lifecycle
list, dropdown list
✔️ Select Widgets to expand the list.
✔️ Select a widget from the Widgets list.
✔️ Select a widget from the Widgets dropdown list.
❌ Select a widget from the Widgets "drop-down list."
❌ Select a widget from the Widgets "drop list."
For details on creating bulleted and numbered lists, including procedures, see Microsoft style guidelines for lists.
menu
The word menu should be preceded by the name (that is, the label) of the menu. Avoid using if the label alone is sufficient.
✔️ Select User. (To open the User menu.)
✔️ From the Dynatrace menu, select...
✔️ From the menu on the left, select...
✔️ In the Edit dashboard menu, select Colors and then choose a color.
❌ "Open the top-left menu."
mobile devices, tablets
✔️ mobile device
✔️ tablet
❌ "iPhone" or "iPad" (when referring generically to devices and tablets)
❌ "cell phone" or "mobile phone"
For details on referring to computers and devices, see the Microsoft style guidelines.
multicloud
multidimensional
✔️ multidimensional
❌ "multi-dimensional"
need to
✔️ For best results, you need to install a proxy.
❌ For best results, you "have to" install a proxy.
❌ For best results, you "must" install a proxy.
observability
on-premises
✔️ on-premises
❌ "on-premise"
❌ "on-prem," "onprem," or "on prem"
open source (noun), open-source (adjective)
OpenStack
OpenTelemetry
OpenTracing
page
As a web application, the Dynatrace web UI comprises pages (webpages), not "screens."
✔️ Select Configure in the lower-right corner of the page.
❌ Click Configure in the lower-right corner of the "screen."
❌ You'll find the details listed on the Applications "screen."
Platform as a Service (PaaS)
please
Only required when asking the user to do something inconvenient or in response to a problem with our product.
✔️ Please open a support ticket.
✔️ Please refer to Red Hat documentation for further details.
❌ "Please" install OneAgent.
plugin
Use only when referring to third-party products, such as a browser plugin or Dynatrace plugins in a third-party store for an application we integrate with.
✔️ Install the third-party plugin.
❌ Install the third-party "plug-in."
Do not use "plugin" when referring to a Dynatrace extension.
pod
✔️ pod (lowercase when referring generically to how containers and pods operate)
✔️ Pod (uppercase when used in a product name such as Kubernetes Pods)
Preview, Preview release
✔️ Preview release
✔️ The following APIs are now available as Preview releases.
✔️ The following APIs are now available in Preview.
❌ Preview "Release"
See Previews and Early Adopter releases for details.
real time, real-time
✔️ real time (noun)
✔️ real-time (adjective)
❌ "realtime"
real user [data | monitoring | metrics]
No hyphen required, even when used as an adjective.
recommend
✔️ We recommend that you install a proxy.
✔️ We do not recommend that you install a proxy.
❌ We "suggest"...
❌ "Dynatrace recommends"...
❌ "It's "recommended"...
reinstall
✔️ reinstall
❌ "re-install"
REST API, RESTful API
✔️ REST API
✔️ RESTful API
❌ "Rest" API
root cause analysis
No hyphen required.
RUM JavaScript
✔️ RUM JavaScript
✔️ Real User Monitoring JavaScript
❌ JavaScript "agent"
❌ "RUM JavaScript agent"
❌ "RUM JavaScript tag"
❌ "RUM JavaScript code"
RUM JavaScript is an umbrella term that encompasses the injection formats listed below. Use the following terms only in the context of discussing injection formats for RUM JavaScript/RUM injection/manual insertion:
✔️ JavaScript tag
✔️ OneAgent JavaScript tag
✔️ Inline code
✔️ Code snippet
Also see agent, OneAgent, and JavaScript.
runtime
✔️ runtime (Works as both a noun and an adjective.)
❌ "run-time"
❌ "run time"
see
Use see when providing references to internal Dynatrace or external resources.
✔️ See <Topic title>.
✔️ See <Topic title> in Dynatrace Documentation.
❌ "Refer to" <Topic title>.
❌ For details, "go to" <Topic title>.
Also see Dynatrace Documentation.
select
✔️ Select Install now.
❌ "Click" Install now.
❌ "Click" the Install now button.
✔️ Right-click Install now. (mouse actions only)
service-level [objective (SLO)] [agreement (SLA)]
❌ "service level" objective (SLO)
❌ "service level" agreement (SLA)
set up, setup
- Two words as a verb; one word as an adjective and a noun
- Use as a verb to describe the process of preparing hardware and installed applications for initial use.
- Don't hyphenate.
✔️ Unpack everything before you set up your computer.
✔️ The setup time is about 15 minutes.
✔️ Your office setup should be ergonomically designed.
❌ Now you can "setup" your environment.
❌ Now you can "set-up" your environment.
See the Microsoft Style Guide for more information.
shift-left testing
sign in, sign out, signed out, single sign-on
- You sign in to Dynatrace, not "sign into."
- Don't use "log in," "login," "log on," or "logon" as verbs for signing in to Dynatrace.
- You may use login as an adjective, as in "login credentials."
- You may use log in as a verb with third-party tools that use the term.
✔️ Sign in to Dynatrace.
✔️ Sign out of Dynatrace.
✔️ Once you're signed in, check your notifications.
✔️ The files are signed out right now.
✔️ You may use the credential vault to store login credentials.
✔️ Use single sign-on (SSO) to simplify your work.
✔️ Sign in to Dynatrace using single sign-on.
❌ "log in," "login," "log into," "log on," "logon," "log onto," "sign on," "signon," "sign into (Dynatrace)" (Exception: When documenting a third-party tool that uses the phrase "log in")
slash, backslash, forward slash
Don't use slash symbols to indicate "and/or."
✔️ C:\Windows\
(Windows backslash)
✔️ /home/user/
(Linux forward slash)
❌ The software will be released around "October/November."
Software as a Service (SaaS)
such as, for example, including
Each of these phrases can be acceptable, though for example followed by a comma is usually the best option in Dynatrace language. Avoid "for instance" as it means "Here's an example of an instance just like you described."
✔️ There are options to consider, such as the launch date.
✔️ There are options to consider, including the launch date, the launch site, and publicity.
✔️ For example, you need to consider the output format.
❌ Let's say, "for instance," that you've discovered a bug in your code.
❌ "(e.g., Windows & Linux)"
See example, for example.
switch
- It's okay to use switch as a noun to refer to a CLI or compiler options, such as
/Za
. - As a verb, use switch in place of "activate" or "toggle."
✔️ Select Alt+Tab to switch between open windows.
❌ Select Alt+Tab to "toggle" between open windows.
Also see turn on, turn off and toggle.
that, which
Include that at the beginning of a clause that’s necessary for the sentence to make sense. Use which at the beginning of any clause that adds supporting or parenthetical information and place a comma before it.
✔️ To learn more about features that aren’t supported in the trial version, see the chart.
✔️ Catch the latest episode of “This Week on Windows,” which looks at the new Surface Book and more.
✔️ The chart shows which features aren't supported.
✔️ The host that isn't responding won't be included in the report along with the other hosts.
✔️ This host, which currently isn't responding, won't be included in the report with the other hosts.
✔️ Extensions that can save you time include...
✔️ Extensions, which can save you time, include...
✔️ Laptops (noun) that are used for gaming purposes (restrictive clause) are usually more expensive.
✔️ The chair (noun) in my kitchen that has a broken leg (restrictive clause) is dangerous to sit on.
✔️ Stacy’s truck (noun), which is painted red (non-restrictive clause), has a dent in the back bumper.
✔️ The human heart (noun), which contains four valves (non-restrictive clause), weighs approximately eleven ounces.
❌ The chair in my kitchen "which" has a broken leg is dangerous to sit on.
❌ Stacy’s truck "that" is painted red has a dent in the back bumper.
❌ The human heart, "that" contains four valves, weighs approximately eleven ounces.
See the Microsoft style guidelines for use of "that" and "which."
that is
Use that is (rather than "i.e.") to indicate "in other words." The phrase should be followed by a comma. Omit the phrase if the context is clear.
✔️ To monitor the entire environment (that is, all components), install Dynatrace.
❌ To monitor the entire environment ("i.e.," all components), install Dynatrace.
their, them, they
Use their, them, and they instead of "he," "she," "his," or "her."
✔️ Then the user can install their software.
✔️ <user name> has paused their notifications for a bit, but they'll see your message when they're back. If you need to get their attention right away, you can choose to notify them anyway. (Slack example)
✔️ If your user has sufficient privileges for the token, the software will provide it to them.
✔️ Now the user needs the token that they downloaded.
❌ Then the user can install "his or her" software.
❌ If your user has sufficient privileges for the token, the software will provide it to "him or her."
❌ Now the user needs the token that "he or she" downloaded.
third-party, third party
Spell out as two words. Hyphenate as an adjective.
✔️ You can license third-party software.
✔️ A third party owns the company.
❌ "3rd-party"
❌ "3rd party"
time
- Use AM and PM preceded by a space.
- UTC 24-hour format is acceptable, but not the preferred time format for US users.
- See Units on the Barista design site for details on how to write units of time and their abbreviations.
✔️ 8:00 AM–4:00 PM
✔️ 08:00:00Z–16:00:00Z (UTC)
❌ The event took place at "8:00." (It's not clear if this is AM or PM.)
❌ The duration of the event was "08:00." (It's not clear if these are hours and minutes or minutes and seconds.)
time series
❌ "timeseries"
time to value
time-out, time out
Spell out as two words. Hyphenate as an adjective; don't hyphenate as a noun.
✔️ Set the time-out period.
✔️ The request times out.
✔️ The connection timed out.
✔️ If your applications time out before a response is received...
timeframe
One word, to refer to a duration of time
✔️ timeframe
❌ "time frame"
timestamp
One word as a noun or a verb
✔️ Each log entry has a timestamp.
✔️ Each log entry is timestamped.
❌ "time stamp"
toggle
- Don't use as a verb (use switch instead).
- Only use toggle when it's necessary to refer to a toggle-type UI control that doesn't have a clear label. In most cases, avoid using if the label alone is sufficient.
- Use turn on and turn off as a verb with toggle controls.
✔️ Select Caps lock to switch from typing capital letters to typing lowercase letters.
✔️ To switch between Normal, Outline, and Slide Sorter views, use the buttons on the View tab.
✔️ To make text and apps easier to see, turn on the toggle under Turn on high contrast.
✔️ To keep all applied filters, turn on Pass all filters.
❌ To keep all applied filters, "turn on the Pass all filters toggle."
❌ Select Alt+Tab to "toggle" between open windows.
Also see switch.
turn on, turn off
- Use turn on and turn off instead of "power on," "power off," "start," "stop," "switch on," or "switch off" to mean turning a device on and off.
- Use turn on and turn off instead of "enable" and "disable" when referring to a toggle control.
- Use turn on and turn off instead of "enable" and "disable" to refer to commands and features that can be hidden or deactivated.
- Don't use to refer to selecting or clearing checkboxes in instructions. Use "select and clear instead.
✔️ To turn on your device,...
✔️ To turn off pop-up blocking,...
✔️ If the command prompt isn’t available, your network administrator might have turned off this feature.
✔️ To keep all applied filters, turn on Pass all filters.
❌ To keep all applied filters, "turn on the Pass all filters toggle."
❌ Your administrator must "enable the feature flag toggle" for this option to be available.
units, numbers
See Format Units on the Barista design site for the format and standard abbreviations for numbers, data units, units of time, days and months, durations, and Dynatrace metric aggregation.
- Include a space between the value and unit type. For example, 16 GB.
- When the number and unit type work together to modify a noun, use a hyphen (for example, 16-GB file or 64-bit operating system).
- Use a forward slash (
/
) to indicate the "per" portion of a rate expression. For example, GBs per minute = GB/min.
Please note that the Barista units page is incorrect in that there needs to be a space between the unit of measure and the numeral. So 1,000
= 1 k
, not 1k
.
use case
✔️ Regardless of your monitoring use case, Dynatrace has you covered.
✔️ While Dynatrace provides a comprehensive digital monitoring solution, this use-case example might be of particular interest to you.
version
- Dynatrace has numbered release versions. Use a plus sign (
+
) to indicate "and later versions." - Use release to refer to General Availability, Early Adopter, or Preview releases. See Previews and Early Adopter releases for examples.
- Use version when referring to a version number.
✔️ OneAgent version 1.151
✔️ OneAgent version 1.151+ (Means "OneAgent versions 1.151 and later.")
✔️ OneAgent versions 1.151 and earlier
❌ OneAgent versions 1.151 and later
❌ OneAgent "release" 1.151
❌ "older," "newer," "higher," "lower," "above," or "below" to indicate earlier or later releases
versus, vs
In headings, use the abbreviation vs. (all lowercase). In text, spell out versus.
✔️ Automated vs. manual instrumentation (an example heading)
✔️ For details on how you can manage privileged versus non-privileged modes for OneAgent deployment,...
❌ For details on how you can manage privileged "vs." non-privileged modes for OneAgent deployment,...
via
✔️ Communication is handled via third-party integration.
we, you
- Use we when referring to actions Dynatrace has taken or when referring to the employees of Dynatrace.
- Don't use "we" when referring to functionality of our software.
- Address the reader as you.
✔️ We recommend that you adjust your privacy settings.
✔️ Before proceeding, you need to configure privacy settings.
✔️ Dynatrace analyzes all the data and dependencies for you.
❌ "Dynatrace recommends..."
❌ "It's recommended..."
❌ "We" analyze all the data and billions of dependencies for you.
See you, you've, you'll, you're.
web
Don't capitalize web unless it's the first word in a sentence, if the word is displayed standalone as a header, or if the word is part of a name such as Amazon Web Services.
✔️ web
✔️ webpage
✔️ website
✔️ web application
❌ "web page"
while
Use only to refer to something occurring in time. Don't use as a synonym for although, whereas, on the contrary, or in spite of.
✔️ We're having trouble getting this information right now. Check back in a little while.
✔️ Although the icon indicates that the print job is done, you might have to wait while previous jobs are completed.
Also see although.
you, you've, you'll, you're
Address readers in the second person with you and related contractions.
✔️ You can configure the settings to meet your needs.
✔️ Once you've installed the software, you'll be ready to start monitoring.
✔️ Now you're ready to start monitoring.
❌ Customers must provide their own credentials.
❌ Once you have installed the software, you will be ready to start monitoring.
In many situations (for example, DEM the user (referred to as you) in turn has end users of their own (that is, the user's customers).
✔️ You might need to notify your end users.
See we, you.
Words to avoid
slave {{versiontag 'forbidden in all cases'}}
- Suggested replacement: subordinate
- Other options: node, replica
blacklist {{versiontag 'forbidden in all cases'}}
- Suggested replacement options: blocklist, exclusions, exclude list, deny list, or reject list
whitelist {{versiontag 'forbidden in all cases'}}
- Suggested replacement: allowlist
- Other options: safelist, allowed list, inclusions, permit list, or safe senders' list
master {{versiontag 'strongly discouraged'}}
While the word "master" on its own (in the absence of "slave") isn't strictly forbidden, you should make every effort to replace it with a synonym below.
- Suggested replacement: primary, main, or seed node
- Suggestions for people: pro, maven, virtuoso, genius, wizard, authority, principal, controller, conductor, captain, guide, or agency
- Relationships between people: principal/agent, controller/worker, agency/agents, agency/operatives, captain/conscripts
- Suggestions for components: primary, original, template, or hive
- Relationships between components: primary/subordinate, primary/replicas, primary/secondary, original/copies, template/copies, hive/drones
- Don't use primary/subordinate as a synonym for parent/child relationships.
✔️ Each subordinate device has a unique 7-bit or 10-bit address.
✔️ The architecture uses a standard primary/subordinate design to replicate data from one server to many.
native {{versiontag 'avoid'}}
Avoid using "native" to refer to people. When referring to software products, try to use a more precise term (for example, use built-in to describe a feature that's part of a product).
The term "native" also isn't necessarily clear (for example, cloud-native could mean that something was written for the cloud, or that it's built in to a cloud platform, or that it currently exists in a cloud platform).
Use American-English spellings (rather than British)
behavior
❌ "behaviour"
catalog
❌ "catalogue"
center
❌ "centre"
color
❌ "colour"
endeavor
❌ "endeavour"
favorite
❌ "favourite"
organization
❌ "organisation"
while
❌ "whilst"
Registered trademarks
Davis®, Hyperlyzer®, OneAgent®, PurePath®, and Smartscape® are some of the registered trademarks of Dynatrace. Our legal team requires that a registered trademark symbol be used for all mentions in press releases and other announcements that are distributed in outside forums. A trademark symbol isn't required for every mention in our Documentation or product UI. To create a registered trademark symbol with superscript formatting in Markdown, use this string: <sup>®</sup>
.
- Where possible, use the trademark as an adjective, for example, PurePath traces, so long as it describes a noun for a product feature or capability.
- As a corollary, avoid using the trademark as a noun.
- Where possible, avoid using the trademark in the plural form, for example, "Purepaths" or "OneAgents."
- Avoid using the trademark in the possessive form, for example, "OneAgent's..."
- Don't insert a space between the trademark and the superscripted symbol.
- Symbols go before the punctuation following a trademark, for example, Davis®, OneAgent®, and Smartscape®.
See the list of Dynatrace trademarks and trademark guidelines. For questions, contact legalnotices@dynatrace.com.