Download Technical Writing Style Guide

Transcript
Correct
When finished with the editing, print the file.
Incorrect
When done, print the file.
email



Use email to refer to an electronic mail program, as in send the file using
email, but use email messages, or just messages or notes, to refer to
pieces of email.
It may be used as a verb, as in email the file.
Do not capitalize the e in email. Use Email only at the beginning of a
sentence and in headings.
em dash
A mark of punctuation used to mark a break in thought, to set off a parenthetical
element for emphasis or clarity, and to set off an introductory series. A dash is equal
to the width of an uppercase M in the font style being used. Use dashes sparingly
and not as easy or automatic substitutes for commas, semicolons, or end marks.
Note: In RoboHelp, insert an em dash or en dash by clicking the Insert menu, then
clicking Symbol.
en dash
A mark of punctuation used with sets of numerals, letters, or a combination of both;
exceptions include numbered designations of aircraft (DC-10) and highways (I-15),
which use hyphens. An en dash is half the width of an em dash and longer than a
hyphen.
Note: In RoboHelp, insert an en dash or em dash by clicking the Insert menu, then
clicking Symbol.
enter, type



Use type to describe what users type in a screen, window, or page.
An exception to this rule applies when documenting a combo box. It is
acceptable to tell users to enter a choice when they can either type a value
or select one from a list.
Use a combination of words such as type or select if space is not an issue.
Correct
Type the password.
Enter the file name. (only when describing a combo box)
Type the path to the server or select it from the list. (only when describing a combo
box)
Incorrect
Enter the password.
Page 101 of 119