Writing “Concept” topics

Print topic Print topic Previous topic  Next topic

“Concept” topics provide basic information and describe how things are related. They contain overviews, definitions, rules, and guidelines.

The goal of a Concept topic is to help users understand the basic principles so that they can make informed decisions and explore the product largely on their own.

Concept topics are primarily for beginners.

Expand /Collapse All Subsections

Dos and don’ts

In Concept topics, don’t swamp users with details. Mention only the basics that users should actually memorize.

Instead of just mentioning facts, provide explanations. Show how things are related.

Use pictures if you can.

Use examples and metaphors that help readers relate the information to their own work, knowledge, and experience.

Don’t give instructions. For this purpose, use a Task topic instead (see Writing “Task” topics).

Don’t provide tables, lists, or diagrams that are mainly intended for users to look up specific data. For this purpose, use a Reference topic instead (see Writing “Reference” topics).


Writing “Task” topics

Writing “Reference” topics

Structuring: Make topics self-contained

Structuring: Write meaningful headings

Structuring: Distinguish information types