Link text
Guidelines for writing meaningful link texts in the Dynatrace style.
Good link text plays a crucial role in supporting user experience across Dynatrace. Links are essential for helping users navigate content and easily access the information they need to achieve their goals.
Reflect the title of the target page
Link text should be descriptive and include words from the title of the target page or app. If the title of the target page is too long to use for the link text, you may shorten it. However, strive to make the target title recognizable in the link text.
✅ The Grail data model consists of Grail buckets, tables, and views.
✅ For more details, go to Dynatrace Query Language.
✅ Discover how to analyze OpenTelemetry traces and log data at scale.
Avoid generic link words
Don’t use short, generic link terminology like “here,” "this page," “link,” or “more.” Instead, aim to make your link texts descriptive. Avoid using an entire question for link text, such as “Ready to get started?”
When a sentence ends with a link, include the closing punctuation in the link.
❌ See documentation.
❌ View more here.
❌ Go here for more details.
❌ Discover how on this page.
❌ Want to learn more?
Avoid title case
All Dynatrace page titles and headers should be written in sentence case; consequently, link texts should also be written in Sentence case.
If a link appears at the beginning of a sentence or as a standalone statement, capitalize the first word and all proper nouns (for example, an app name or acronym). Use lowercase for the first letter of the link if the link text appears in the middle of a sentence and describes the target page but doesn’t duplicate the title.
✅ Go to Configure a processing pipeline.
✅ Hassle-free log data management lets you ingest petabytes of data without schemas, indexing, or rehydration.
✅ Select the Visual tab to change the visualization. Go to visualization documentation for more details.
❌ Go to Configure a Processing Pipeline.
❌ Hassle-free management of your log data lets you Ingest petabytes of data without schemas, indexing, or rehydration.
❌ Select the Visual tab to change the visualization. Refer to our Visualization Documentation for more information.
Use approved interaction verbs
We use different verbs for different types of user interactions. For example, use “visit” for optional, non-critical reference material and “go to” when the reference material or target destination is required to finish a task. For complete details, go to Interactions with web UIs.
✅ Go to Global field reference to identify the correct attribute.
✅ To browse our app catalog, visit the Dynatrace Hub.
Inline links
Inline links are hyperlinked phrases that direct readers to related content. They allow readers to view supporting content without disrupting context or content flow. Unless they include a product name or acronym, inline link texts are written in lower case.
✅ A user experience score is calculated for each user session.
✅ To avoid false-positive problem notifications, automated anomaly detection is only available for applications and services that have run for at least 20% of a week.
Standalone links
A standalone link appears as a standalone statement on a separate line. Below are common standalone link text patterns. When adding multiple links, vary the patterns to avoid repetition.
| Link pattern | When to use |
|---|---|
| To learn more, go to Dynatrace App name. | In-product navigation |
| Learn more about a topic of interest. | Reference material |
| For complete details, go to Title of target page. | Reference material |
| Learn how to achieve a user goal | Reference material |
| For instructions, go to Title of target page. | Required task |
| To achieve a user goal, go to Title of target page. | Required task |
| To browse Dynatrace Apps, visit the Dynatrace Hub. | Optional CTA |
| To learn about your options, visit Dynatrace Documentation. | Optional CTA |
External links
When a link that appears in the Dynatrace web UI or Dynatrace Documentation directs the user to a different content channel (for example, linking from Dynatrace Documentation to an app, or vice versa), an external link icon is automatically generated at build time, as shown in the link example below.
