Consistency, Precision, and Language

Consistency

Consistency is an essential element of style. Consistency and a unified voice create an environment of trust and engagement with our users. Consistency in the following three areas will help make our message more effective:

consistent terminology
consistent syntax
consistent formatting

Consistent Terminology

Consistent terminology reduces confusion by minimizing the need for users to figure out whether different words and actions mean the same thing. Consistency promotes a better understanding of technical concepts.

Room for improvement: Consistent terminology within the Info Dev deliverables compared to consistent terminology across the organization (product interface, support, marketing).

Examples:

switch, toggle

start, launch, boot

burn, copy

Note: Consistent terminology also means the documentation matches the interface. Meaning, the documentation should mirror whatever naming conventions in place within the product interface, even if the products themselves are inconsistent.

Consistent Syntax

Consistent syntax helps users know what to expect, which makes it easier for users to understand. Use the same syntactic structure for writing procedures, for documenting technical information (for instance, web services documentation), and for guiding users through the user interface.

Consistent Formatting

Formatting is a powerful tool to help reinforce the message provided within the text itself. Consistent formatting reduces ambiguity and allows users to quickly scan the content.

Heading styles

Heading levels

Graphics - with or without captions

Tables

Precision

Precision is about ommitting needless words and using words with clear meaning. It also means using words accurately and consistently. When necessary, use context to reduce ambiguity, especially with terms that can be used as either verbs or nouns.

Although the use of synonyms may be more interesting to read, users may assume that your choice of a different word indicates a subtle distinction.

Table 1. Examples
Correct	Incorrect
Follow these steps to change your password.	Follow these steps in order to change your password.
It isn't difficult to change your password.	It isn't terribly difficult to change your password.
Because you created the table, you can make changes to it.	Since you created the table, you can make changes to it.
Click the Save button.	Click on the Save button.
When you lock your computer...	When you lock down your computer...

Language

Use everyday language when you can. Avoid formal language that you wouldn't use when speaking to someone in person, especially if you are explaining something complex or technical. Use lanauge and style that is familiar, as if you were explaining something face to face.

Short, plain words are best. Short words are more conversational and save space and are easier to scan.

Example


Correct	Incorrect
This section shows you....	In addition, this section shows you....
Digital cameras use tiny microchips.	Digital cameras utilize tiny microchips.

Don't invent words or apply new meanings to words. For example, avoid creating fake verbs from nouns, such as bucketize, for instance. You should assume that users are more familiar with a word's standard meaning rather than a special, jargon-like meaning applied by the technology industry.