Create documentation that is clearly organized and logically arranged by following our structure advice.
Titles give the essence of the information that the user is about to digest. Creating effective titles for help topics, articles, or headings is a key part of our job.
- References to times of the day
Follow a consistent format when you refer to times of the day in your content.
- Fictitious information in examples in text, images, and code examples
Fictitious examples that include the names of people, places, organizations, or personal information are always potentially sensitive, both legally and from the worldwide perspective.
- Guidelines for creating lists
Organize information into lists when appropriate for enhanced clarity and brevity.
- Creating tutorials
Though procedural in nature, tutorials provide more supporting information than help topics. A tutorial focuses on the detailed scenario steps, but also provides an introduction to the entire use case to ensure that users understand the purpose of that process.
Previous topic Hyperlinks and cross-references Next topic Titles