Topic title guidelines

Last Updated : Jun 04, 2014 |
Prolog information
Metadata
Keywords:

General guidelines

Some general guidelines apply to all topic types:
  • Compose titles that are clear and concise.
  • Use words that the user would understand in addition to or instead of feature and product names.
  • Make sure that the title tells users exactly what information is in the topic.
  • Create titles that provide a clear indication of the topic scope.
  • Use sentence-case.
  • Avoid constructions using the word for.
  • Use plural unless the information specifically refers to a single object.

Task titles

Begin all task topic titles with an ing verb. For example, for a task on adding new users, use a task title similar to Adding new users.
Incorrect
Correct
Build a Work Flow
Building workflows
Administer parameters for voicemail
Setting voicemail parameters
Editing the Element Manager
Assigning a certificate to the Element Manager

Description concept titles

Use the name of the thing that the topic describes. For example, title a description concept Administrator login type.
For topics with overview content, avoid titles that begin with an ing form. If renaming the topic to avoid starting with a gerund creates an awkward title, use the gerund. Also, try to avoid using the words overview or “about in concept titles, unless there is a need to distinguish a concept title from the title of a deliverable or another topic.

Graphical concept titles

Use the name of the thing that the topic depicts graphically. For example, title a graphical concept Message server internal view.

Example topic titles

Include example in the title to make it clear. For example, Dial plan configuration example.

Scenario topic titles

Use the name of the thing that the topic provides a scenario for.

Field description structure titles

Begin all field description structure topics with the name of the page or dialog box followed by field description. For example, title a field description structure Call Profile field descriptions.

Report output titles

Use the name of the report followed by something like report results or report output.