Download Technical Writing Style Guide

Transcript
Incorrect
The printer might insert stray characters when the wrong font cartridge is selected.
To find out if TrueType fonts are available…
When the document will not print…
If the document is ready to print…
impact

Do not use as a verb—it’s jargon. Use affect or another synonym instead.
Correct
Sending an inappropriate email message can adversely affect a person's career.
Incorrect
Sending an inappropriate email message can adversely impact a person's career.
in order to

In order to is verbose; just use to instead.
Correct
To open the program, click File, Open.
Incorrect
In order to open the program, click File, Open.
inbox
In Outlook, a folder in which incoming messages are stored. As a physical entity, a
tray, basket, or similar item used to hold incoming letters, messages, or documents.
Use one word.
infinitive phrase
In procedure topics, a phrase that begins with "to" and ends with a colon. It
introduces a set of steps that accomplish a task, and restates the topic title in
singular form. A single procedure topic may have multiple related tasks and
therefore multiple infinitive phrases. An example of an infinitive phrase for a topic
named "Processing Western Union Payments," is To process a Western Union
payment:
in, into


In indicates within the limits, bounds, or area of a place or object.
Into implies moving from the outside to the interior of a place or object.
Correct
A word is in a paragraph, but text is moved into a document.
Data is in the cell of a worksheet.
Page 104 of 119