Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      


Updated on January 21, 2021

Create documentation that is clearly organized and logically arranged by following our structure advice.

  • Titles

    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.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us