Documentation Structure

In our documentation, we divide information into three different types of topics, according to their content.

Descriptions of the User Interface

Topics that describe the functionality of user interface items and list the options and settings of dialogs, panels, or other items.

Descriptions of Basic Concepts

Topics that describe concepts and explain the functionality of a specific software feature.

Descriptions of Procedures

Topics that provide step-by-step instructions for how to perform a specific task. These topics often provide an example for why you might want to follow the steps and a brief summary of the result, including consequences to be aware of.

Because of this division of information, our documentation structure functions as a reference you can consult for specific information or instructions as required, rather than a guide you must read from start to finish.

Tip

Descriptive topics do not describe how to perform a task, and procedural topics do not explain what something is. To find general information about items or concepts, we recommend searching for them by name, such as “events”. To find instructions for performing particular actions, we recommend including a relevant verb in your search, such as “recording”.

Links at the bottom of topics guide you to further relevant content. You can also check the sidebar for nearby, related topics in the documentation structure.