Writing topics

Print topic Print topic Previous topic  Next topic

Don’t mix information types. For each topic, decide on one specific information type, and then write the text specifically for this information type (see Structuring: Distinguish information types).

Choose a topic title (heading) that clearly communicates both the topic’s information type and the topic’s content (see Structuring: Write meaningful headings and Structuring: Tips for writing headings).

When you write the topic’s body text, don’t assume that readers have read the heading. This often isn’t the case, particularly in online help when users come to a topic via search or via a link.

 

No:

heading: Printing Reports
first sentence in topic: This can be done with the Print command.

Yes:

heading: Printing Reports
first sentence in topic: You can print Reports with the Print command.

Expand /Collapse All Subsections

Rules for standard topic types

Follow the specific writing rules for the topic’s information type:

Writing “Concept” topics

Writing “Task” topics

Writing “Reference” topics


Writing in general

Writing sections

Writing sentences

Writing words