Content
- How to
- 5 minutes
Words matter. The content in our apps and documentation shapes how users experience Dynatrace. When content works well, it's barely noticed, but the whole experience is better: learning is more intuitive, decisions are easier, and the style "feels" right.
The Dynatrace Content Style Guide explains in detail how to write for our products and documentation. It covers everything from the personality and voice of Dynatrace, down to where to place commas. When you have questions about content for Dynatrace, our Content Style Guide is your go-to.
Sometimes you need a checklist of reminders and quick links to specific instructions. That's what this page is for. Use it to ensure that your content supports good user experiences while meeting Dynatrace standards.
Terminology and style
Content is error-free, follows our style and grammar rules, and uses Dynatrace terminology correctly.
Grammar and style
| Content standard | Resources |
|---|---|
| Spelling and grammar are correct for American English. | - Use a spelling and grammar checker set to American English. - Dynatrace grammar - American English spelling |
| Common contractions are used. | - Contractions - When to spell out negative contractions |
| Numbers, units, and dates conform with our style guide. | - Dates and times |
Terminology, names, and trademarks
| Content standard | Resources |
|---|---|
| All terminology, trademarks, and names are correctly written and align with industry standards. | - Dynatrace terminology |
Brand voice and tone
| Content standard | Resources |
|---|---|
| The brand voice sounds like Dynatrace and the tone is right for the user's situation. | - Voice and tone |
Punctuation
| Content standard | Resources |
|---|---|
| Headings and UI elements (such as buttons or menu items) don't use closing punctuation, "-ing" verbs, or question marks. | - Page titles, headings, and subheadings |
| Content is sentence case (except for branded names and proper nouns). | - Sentence case |
| Content uses the serial (Oxford) comma. | - Serial commas |
| Punctuation is correct and simple. Ampersand (&) is only used in app names and menu labels. | - Punctuation |
Information experience
Information is clear, concise, organized, and scannable.
Clarity, concision, and accuracy
| Content standard | Resources |
|---|---|
| The meaning is easy to understand using as few words as possible. | - Validate with a grammar checker. |
| Technical and business jargon are explained. Acronyms are spelled out on first use. | - Dynatrace terminology |
| Links are descriptive and function correctly. | - Link text |
| All information is accurate (instructions and journeys work as described). | - Validate with subject matter experts and test with users or colleagues. |
Structure and scannability
| Content standard | Resources |
|---|---|
| Contextual help and information is provided where needed. | - Link text - Guided interaction components and patterns |
| Nothing important is truncated. | - Lead with what's important |
| Information order is logical and doesn't distract users from completing tasks. | - Write for scannability |
| Subheadings, bullets or numbered lists, and tables are used instead of long, dense blocks of text. | - Write for scannability - Use tables |
UI interaction
| Content standard | Resources |
|---|---|
| Standardized UI interaction terms are used to set the right expectation for what comes next. | - Interactions with web UIs |
| Items in a group are structured alike (e.g., all headers start with a verb) | - Use parallel writing structures |
| Primary and secondary actions are understandable and consistent. | - Check the Usage tabs of Strato components for component-specific content guidelines. |
Accessibility
The content is inclusive and accessible to all its users.
| Content standard | Resources |
|---|---|
| Content is direct and uses active voice when possible. | - Active voice |
| Images and components have alt-text and aria labels, as needed. | - Check the Strato components documentation. |
| Content is inclusive and doesn't make assumptions about users. | - Inclusive language |
| UI content uses digits (1, 2, 3). Other content types, such as documentation, spell out numbers from zero to nine. | - Numbers in sentences |
| Content doesn't use emoji. | - Emoji |
Consistency and scalability
Content is consistent, reusable, and scalable.
| Content standard | Resources |
|---|---|
| App names and app icons comply with our guidelines. | - App naming - Plural nouns as adjectives |
| Content is ready for localization. | - Internationalization and localization |
| Content components are reusable and follow established patterns where applicable. | - Check the Usage tabs of Strato components for component-specific content guidelines. |