Example Topic Type

  • Article

Helps the user understand procedural or conceptual information. Most examples should be included in the task or overview topic that the example illustrates. However, extended examples can be in a separate topic.

Coverage

Include examples to illustrate difficult concepts or to demonstrate the results of choosing different options or methods.

Elements

This topic includes the following elements in the following order. Bold sections are mandatory components.

Section Description

Topic title and heading

<Example + a procedure type heading>, such as "Example - Posting XYZ"

Text

Some explanatory text and example data. It can make the text more readable if you use a table to display the example data.

Format

Use the Emphasize-Code style for formulas and commands and the Emphasize-Input style for text that the user enters.

See Also

Concepts

Help Topic Types
Help Topic Linking
Help Topic Formatting
Help Topic File Names
Help Topic Titles and Headings