What would you like to know more about?

Writing Headings

Headings should reflect the mindset and language of our customers, and should not reflect the organization or language of the software.

  • Preferred: Streaming Worship Services

  • Less Preferred: Getting Started with Realm Streaming

Capitalization

Capitalize the first letter of words in headings, tables, and figure titles. Do not capitalize articles, short prepositions, and short conjunctions — that is, those with fewer than four letters.

  • Correct: Print a Group Roster

  • Incorrect: Print A Group Roster

Length

Headings should be short, preferably three to five words and one line only. They must be action oriented. Use short, concise verbs and the active voice.

  • Preferred: Print a Directory

  • Less Preferred: Exporting a Parish Directory to PDF

Style

The following rules apply to writing headings:
  • Make sure that headings describe the specific task or topic. Avoid using How To headings for a reference section.
  • Avoid using command names in a procedure heading.
  • Be brief and to the point. Avoid an exaggerated, forced, or affected style.
  • Express one thought at a time. For example: "Save a File or Print a Report." If possible, divide the heading into two separate task topics and chunk together, if needed.
  • Avoid using questions in headings, for example: "What's in This Chapter?" Do not use punctuation other than series commas in headings.

Use Action Verbs Where Possible

Most headings for task topics contain an action verb at the beginning of the heading. Do not use the verb as a gerund (-ing verb).

Correct:
  • Print General Ledger Reports.
  • Take Inventory with a Scanner
  • Download Program Updates
  • Understand Reporting Basics

Incorrect:

  • Printing General Ledger Reports

  • How to Print General Ledger Reports
  • About GL Reports