Download here - OoCities

Transcript
Chapter 4 Terminology
111
Do not begin a chapter with a level-one head; start with an introductory paragraph or
two before your first text head. Likewise, do not place a level-two head immediately
after a level-one head, and so on. A brief overview of a section—even if it’s only a
sentence—is useful before you begin using the next level of text head.
If you use a particular level of head at all in a given chapter or section, use at least
two. Strictly speaking, a chapter or section can not be subdivided into only one part.
The wording of parallel head within a section should be parallel: verb forms should be
the same (gerunds, imperatives, and so on) from head to head; comparable terms
should all be either singular or plural, not a mix; and if you’re using complete
sentences for some heads, use them for all comparable heads.
Avoid cute, flippant, or gimmicky heads. Humor can be an effective means of
unhanding the reader’s experience, but it generally works best in the text rather than
in titles or heads. Count on your prose to create the excitement necessary to carry the
reader along; keep heads simple and descriptive.
The capitalization style for all levels of text heads is initial cap only. Avoid colons in
heads whenever possible. If a colon in a head is required, capitalize the first word
after the colon.
that
Use to introduce a restrictive clause; clauses beginning with that are generally not set
off with commas. Compare which.
Correct: This is the house that Jack built. (There are many houses; the phrase that
Jack built restricts [narrows the meaning of] the subject of the sentence to one house.)
Correct: The largest house in town, which Jack’s sister built, is also the newest.
(There is only one largest house; the phrase which Jack’s sister built, although it
provides more information, does not restrict the subject of the sentence.)
3.5
Not 3 1/2 when referring to 3.6-inch disks.
title bar
Two words. Note lowercase.
titled
Not entitled.
title page
All manuals must have a title page. This page is the first in the book (page i) and does
not have a page number or a running foot.
In a manual that will be distributed only in the United States, any trademarked
product whose name appears on the title page must receive the appropriate
trademark symbol. Unlike trademark symbols in running text, the symbols on the
title page align with the base of the product name.
titles, chapter
and section
Mark part titles, chapter titles, and heads concise and consistent. Keep the reader’s
needs in mind, and remember that these elements are used primarily as locators for
someone skimming through a manual.
toolkit
One word.
toward
Not towards.
Handbook for Technical Writers