Technical Writing with Style

A publication that features ideas for writing step-by-step procedures and troubleshooting support documentation for electronic, Internet, and print distribution--and much more!

Table of Contents

 

Period ( . )

A period indicates the end of all sentences, except those that when spoken are exclamatory or a question; in such cases, use an exclamation point or question mark.


Decimal Point

A period is called a "point" or "decimal point" when it is placed before numbers representing a value that is less than 1 in weights, measurements and money. For example, it is placed between the numbers that represent dollars and cents; 1 dollar having the value of 1 and the cents as a value less than 1.

The problem with converting values such as 0.95 pounds or 32.5 feet from their decimal representation to pounds and ounces, feet and inches is one of accuracy; i.e., decimals to fractions. This is why the metric system is proscribed for weights and measurements.


Dots in Abbreviations

A period is called a "dot" when it is used to indicate an abbreviation, for example, U.S.A., 9 a.m., Mrs. Jones, etc. When an abbreviation appears within a sentence, the dot after the last character should be followed by a comma, then by the rest of the sentence. The comma helps the reader to differentiate a dot from a sentence ending period. Exceptions may be made when the abbreviation, or abbr. is italicized and when a paragraph includes more than one of them. When an abbreviation ends a sentence, after its dot, there should be no period.

Abbreviations used in identifying the switches, controls, activity lights, and interfaces on equipment usually do not include dots because of space constraints.

Abbreviations may be either contractions formed by leaving out letters within a word, the first letter of each word in a title or phrase, or a combination of both. When an abbreviation becomes a spoken and recognized word, it becomes an acronym; then dots may no longer be appropriate. For example, when you read: U.S.A., you probably don't translate it into "United States of America;" you simply hear the letters: USA. If you hear the letters rather than translating them, then the abbreviation has become&emdash;for you&emdash;an acronym. When this occurs, it would be appropriate to eliminate the periods and simply type: USA; albeit always printed in uppercase letters.

 

Initials are abbreviated names. The first letter of each abbreviated name (first, middle and last) is capitalized (using uppercase letters) and followed by a dot. There is a space between the dot and the next letter. Most people initialize only their middle name or names for various personal reasons.

Prefixed names retain the prefix when abbreviated; however, the prefix is not followed by a dot. Mary O'Conner's name can be abbreviated as M. O'C. Jim McClure's name can be abbreviated as J. McC.


Dots in Computer Programming

A period also serves as a dot when it is used in computer programing; for example, to separate a file's name from its identifier extension, as for: AUTOEXEC.BAT. In World Wide Web (WWW) and Internet Universal Resource Locators (URLs), a dot separates the address from its class, as in: computers.net. It is also used for other "website" addressing.

To visually differentiate a dot from a period, either give it a bold type style or use a reduced-size bullet in a subscript position at or slightly above the baseline of the text.


Question Mark ( ? )

  • A question mark is used at the end of an interrogative sentence. A question mark is never followed by a period.

Example:

  • Will you do it for me? What?


Question Mark: Interrogatory

A question mark follows an interrogative expression or statement within, as well as at the end of a sentence:

Examples:

  • "Ouch?" he said, "that didn't hurt."
  • "So what?" said Mira, angrily.


Question Mark: Uncertainty

A question mark is used to indicate uncertainty in the accuracy of a statement when it is placed inside parentheses.

Examples:

  • The Mustang (his new car?).
  • Married in 1995(?), they have two children.

    (There is no space between the punctuation and the word it accentuates; therefore, 1995 (?) is not acceptable.)


Question Mark: Exceptions

A question mark is not used after a sentence expressed as a question out of courtesy; i.e., acceptance is implied.

Example:

  • "Will you send this back to me when you are done."

    (There is no space between the punctuation and the word it accentuates; therefore, 1995 (?) is not acceptable.)


A question mark is not used after an implied question or command.

Examples:

  • "I wonder what I will do next."
  • "Guess what."

Exclamation Point ( ! )

An exclamation point is used at the end of an exclamatory sentence and to indicate the an exclamatory part of a sentence. An exclamation point is never followed by a period.

An exclamation point follows an exclamatory expression or statement within a sentence.

Examples:

  • "Ouch!," she shouted, "you hurt! me." (She shouted: Ouch!, you hurt! me)
  • "Ouch! � you hurt! me," she shouted.
  • "Ouch!" she shouted. "You hurt! me." (Shouted refers to Ouch)
  • "Ouch!" She shouted, "You hurt! me." (Shouted refers to "you hurt me")


Exclamation Point: Emphasis

To express emphasis within a sentence, it is less confusing to use a type style like italics or bold, uppercase letters, or even color than an exclamation point:

Contrast the meaning of these three statements:

  • "I love you!" (All words have equal emphasis)
  • "I love! you." (Its more than friendship)
  • "I! love you." (Even if no one else does)

     

    Italics

  • "I love you" Italics (And no one else)
  • "I love you" (Its more than friendship)
  • "I love you" (Even if no one else does)

     

    Bold

  • "I love you." (And no one else.)
  • "I love you." (Its more than friendship)
  • "I love you." (Even if no one else does)

     

    Uppeercase

  • "I love YOU." (And no one else)
  • "I LOVE you." (Its more than friendship)
  • "I love you." (Even if no one else does)

     

    Color

  • "I love you." (And no one else)
  • "I love you." (Its more than friendship)
  • "I love you." (Even if no one else does)


Comma ( , )

A lot of commas, can make normal reading, very difficult; however, for Technical Writing they are can provide necessary support. Instructions are often performed while being read and there is a need for both conceptional clarity and visual reference. For example: read, perform, reread to confirm outcome or troubleshoot technical problems. Most people will glance back to the page at least once to reread a critical sentence or phrase. Commas can make this task easier. For Technical Writing, commas can be effective in expressing concurrent events, while it is better to express sequential events in separate sentences or paragraphs--if there is sufficient space.


Comma: emphasizing words, phrases, and parenthetical elements

Commas are used to set off words, phrases, and parenthetical elements--that retain a close logical relationship to the rest of the sentence. Items of this sort are prefatory exclamations, contrasting expressions, expressions in quotations, and the names of persons directly addressed. (Use dashes or parentheses to set off parenthetical elements which have a remote logical relationship to the rest of the sentence.)

    Examples:
  • More money, not titles, is what I need.
  • Your grades, though not entirely to our liking, are better than we expected.
  • "Don't insert the board with the power on," he said.
  • Mira, you must improve the efficiency of your department.
  • They were, however, still able to get the computer online.
  • Mary, my cousin, will be here soon.


Comma: appositional or modifying words, phrases, or clauses

A comma usually sets off appositional or modifying words, phrases, or clauses that do not limit or restrict the main idea of the sentence.

    Examples:
  • His father, whom we saw yesterday, was not home today.
  • If you refuse to leave, I'll call the police, they will take you away.
  • There are eleven cables connected to the back of the computer, most people would be surprised to know that, USB can replace most of them.


Comma: Substitute for Conjunctions

Commas are used without conjunctions to separate closely related statements or clauses. The introductory element (clause, phrase, conjunctive adverb, or mild interjection) of even a brief sentence requires such emphasis, unless the emphasis is undesirable.

    Examples:
  • He delivered his report, then left the meeting.
  • He will always remember, the experience is now part of him.
  • Don't bother, it doesn't make any difference.
  • After Midnight, they except no deliveries.
  • Well, I was surprised at the results.


Comma: Exceptions in Clauses

The comma may be omitted if the clauses are very short and closely related, and if emphasizing the word before the comma would give the sentence an undesirable meaning.

  • Hi Jim.
  • Hi, Jim.
  • No thanks for the effort.
  • No, thanks for the effort.


Comma: Exceptions in Coordinate Clauses

If the coordinate clauses are long or themselves contain commas, you can often avoid confusion by separating them with semicolons, a conjunction or a period.

    Examples:
  • There are eleven cables connected to the back of the computer, most people would be surprised to know that; USB can replace all of the cables, but the high-speed network and phone line.

If the clauses are long and independent, you can often avoid confusion by inserting a conjunction, usually and or but.

    There are eleven cables connected to the back of the computer, most people would be surprised to know that; but USB can replace all of the cables, except the high-speed network and phone line.

 

If the clauses are long and independent, consider separating them with a period.

  • There are eleven cables connected to the back of the computer, most people would be surprised to know that. USB can replace all of the cables, but the high-speed network and phone line.


Comma: Ambiguity

A comma can be used to avoid ambiguity.

    Examples:
  • To Ruth, James was always a good worker.
  • In 1994, 60% of union members voted for Republicans.


Comma: Transitional Conjunctive Adverbs

Commas set off these transitional conjunctive adverbs---accordingly, also, consequently, furthermore, however, howsoever, indeed, moreover, nevertheless, on the contrary, on the other hand, otherwise, so, still, then, therefore, thus, and yet---when they are subordinate.

    Examples:
  • The question, however, remains unanswered.
  • On the contrary, under the rules, a report is due monthly.
  • Nevertheless, few people purchased the base model of the computer.


Comma: Negative Constructions

For negative constructions, a comma may be placed before the word: because---to clarify which part of the sentence because modifies.

    Example:
  • We didn't go there, because we had too. (This sentence would still be true if you dropped the clause: because we had too.)
  • We didn't go there because we had too; we went there because we wanted too. (This sentence's meaning depends on the clause.)

Comma: Adverbial Expressions

A comma is used to separate expressions such as: namely, that is, i.e., e.g., etc., for example, such as, from what follows.

    Examples:
  • There are two ways to do the job: namely, a right way and a wrong way.
  • He forbad future forays; that is, there were to be no more raids.


Comma: indicating Omitted Words

A comma usually indicates the place of an omitted word or group of words.

    Example:
  • The Champs hard drive is for daily work; the Quantum, for daily backup.


Comma: introducing Direct Quotes

A comma usually separates a direct quote from the rest of a sentence.

    Example:
  • He asked abruptly, "Where is the report?"


Comma: indicating Items in Sequence

A comma follows words and abbreviated numbers that introduce sequential elements in a sentence, a sequence of sentences or paragraphs, and within a list of items. For visual enhancement, italicize the words, and abbreviated numbers.

    Examples:
  • First, leave work early; second, meet up with the guys; third, head to the party.
  • 1st, pay malpractice insurance. 2nd, do no harm. 3rd, bill for real and imagined efforts. 4th, collect.
  • Next, press down on the cap while turning it clockwise.
  • Then, tap: [F2] key while pressing: [Control] key.
  • Again, enter the old password; then, a new password in the space provided.

For alphabetical sequencers, it looks better if lower case letters are used and the comma is replaced by a right parenthesis.

  • I have it all planned: a) leave work early; b) meet up with the guys; c) head to the party.


Comma: in Series

A comma usually separates words, phrases, or clauses that occur in a series.

    Examples:
  • Good food, good drink, good Lord lets eat!
  • We went to the restaurant, ordered a pizza, and ate it.
  • She said, "near the computer: don't eat, don't drink," so we never used it.


Comma: Coordinating Conjunction in Series

A comma is used before the coordinating conjunctions: and, or, when they introduce the final item in a closed series with more than two elements; as well as when, the last item includes the word: and.

    Examples:
  • Paint the wall, but not with that brush.
  • We know very little about the product, and the box had little more than its name.
  • Scientific, technical, and academic periodicals are important sources.
  • The law also prohibits: driving while under the influence of drugs or alcohol, passing on the right, tailgating, and vulgar and obscene gestures.

If a comma is not used before the words: and, or, when they introduce the final item in a closed series the last two items may be considered a special pair.

  • I Guess you know who showed up, Jean, Ted, Bill, John and Mary.
  • We painted the chairs: red, blue, green and yellow.
  • The four winners were: John, 12, Mia, 13, Tad, 13, and Bing, 13. (This simple, visual construction does not require semicolons after the numbers.)


Comma: Coordinating Conjunction joining Clauses

Use a comma before a coordinating conjunctions: and, but, or, for, nor, yet, so, that joins two independent clauses (that could be separate sentences).

    Examples:
  • I don't care what you do, but don't mistake my indifference for acceptance.
  • We tried, yet were defeated by our efforts.
  • We cannot know what it is like, for we were not alive then.

If the clauses are short and closely related, a comma may not be needed.

    Example:
  • I drove and she flew


Comma: exceptions for Coordinating Conjunctions

Avoid placing a comma after the words: and, or, but, for, nor, yet, so, unless the comma sets off a phrase which can't stand alone as a sentence.

    Examples:
  • Do the work. Or, go home!
  • They were guilty. But, not me!


Comma: in Personal Identification

A comma is used to set off titles, degrees, etc., from names.

    Examples:
  • Richard Doe, president.
  • Henry Doe, M.A., Ph.D.

If there is only one, a comma is required; if there may be many, omit the comma.

  • Her friend Tom (She may have more than one friend.)
  • Her husband, Bill.


Comma: in Numbers

In numbers, a comma is used to separate thousand, millions, and other groups of three digits except in dates, page numbers, street numbers, and in numbers of four digits.

    Examples:
  • More than 2,234,345 people were registered.
  • We received 56,890 replies.


Comma: separating sets of Numerals

A comma is used to keep two sets of numerals from running into one another, as in dates.

    Examples:
  • They were both born on January 14, 1950.
  • Was it 345, 349, 354, or 360.


Comma: in Postal Letter Salutations

A comma is customary after the salutation in personal letters and after the complimentary close in all letters.

    Examples:
  • Dear John,
  • Sincerely yours,


Comma: in Postal Addresses

A comma is used in addresses and when numerals are included in a simple series of items where their association is easy to determine.

    Examples:
  • Send your subscription to: BTN, Receiving Department, N. America Ave., Skokie, IL 60076.
  • P.O. Box 99999, West Des Moines, IA.
  • 30303 Whittier Avenue, Richmond, MI.


Semicolon ( ; )

A semicolon usually separates closely-related independent statements or clauses joined together in one sentence without a coordinating conjunction. Both clauses within the sentence must be sufficiently developed to be separate sentences (each ending with a period). The clauses, though they be independent, together both are more fully expressed.

Examples:

  • Make no deals; insist on full restitution.
  • Be careful what you say; your meaning could be misunderstood.


Semicolon: separating Transitional Words, Conjunctive Adverbs

A semicolon separates two statements or clauses when the second begins with transitional words or a conjunctive adverb: accordingly, also, consequently, furthermore, however, howsoever, indeed, moreover, nevertheless, on the contrary, on the other hand, otherwise, so, still, then, therefore, thus, and yet. (For proper emphasis, a conjunctive adverb should be followed by a comma.)

Examples:

  • His sales were the highest in the division; nevertheless, he will not be promoted.
  • He always speaks in a low voice; indeed, even when he is angry, we have to ask him to repeat himself.


Semicolon: separating Phrases, Clauses

A semicolon is used to separate phrases or clauses that are themselves broken up by punctuation.

Example:

  • The US still has many resource advantages over developing nations specifically: a large population of educated people; abundant supplies of fresh water; abundant supplies of low cost electricity, wherever needed; a network of efficient high-speed, heavy load roads; an extensive network of railroad, river and canal transportation systems; excellent telecommunications; a banking and financial structure that encourages business growth and personal wealth. So why do so many business move their research and manufacturing facilities to developing nations? Probably because the legal, regulatory and governmental structures in the US are no longer considered among its advantages.


Semicolon: separating List Items

A semicolon can be used to separate items in lists of names with addresses, titles, or figures where a comma alone would not clearly separate the items.

Example:

  • IBM, Armock, NY; IBM, Boca Rattan, FL; etc.


Semicolon: emphasizing Clausal Relationships

A semicolon can be used to separate items in a list after a colon to express the relationship between each item to the primary clause that preceded the colon. The conjunctions: and, or, but may be used to introduce a list's final item. If each item in the list starts on a new line, the first word may be capitalized to distinguish each item.

Example:

  • The Privacy Agreement specifies that Internet providers of personal information:
  • Stop providing unlisted phone numbers and addresses not obtained from a public source;
  • Make it impossible for online searches using social security numbers;
  • Stop selling general information on children;
  • Stop selling credit histories;
  • Stop selling medical records if not drawn from a public source; and
  • Let consumers remove nonpublic information about themselves from online databases.

Colon ( : )

A colon separates two parts of a sentence; the part after the colon, usually: restates, sums up, balances, or amplifies the idea expressed in the first part. When a colon is placed just after an abbreviation, do not insert a comma after the abbreviation.

Example:

  • A good writer uses: e.g.: not e.g.,: or e.g: which dosen't look proper.
  • The same space appears on the statement: the buyer must sign there to indicate his or her approval.


Colon: Formal Introductions

Use a colon to introduce a formal statement, definition, explanation, or a quotation of more than one line.

Example:

  • To quote your speech at the convention: "We cannot surrender our freedom to the convenience of governmental promises, however nice they may sound."
  • The conjunctions: and, or, but may be used to introduce a list's final item.
  • Type: AUTOEXEC.BAT , then press: [ENTER] key.
  • Type: AUTOEXEC.BAT , then press: [ENTER] key.

    (The italics gives the words type and press the special emphasis of commands without being demonstrative. The second time you read the sentence, they almost disappear, but you still know what you have to do.)

A colon is used after a formal salutation in a letter; typically a business letter.

Example:

  • Dear Mr. Johnson:


Colon: List Introductions

Use a colon to introduce a lists of more than a few items in support of the idea expressed in the statement or clause that proceeds the colon. Such items may either continue on the same and any succeeding lines as may be required, or parsed one item per line.

Example:

  • I know them all: stop sign, yield sign, no left turn, no turn on red, no U turn, no passing, a divided road, caution, school crossing, no parking, and so on.


Colon: in Titles

A colon is used to separate a title from a subtitle when the subtitle is not on a second line, in quotes, or set in a different type style; e.g., in italics.

Example:

  • Annual Report: December 1998.


Colon: in Formulas

Colons function as dividers in set formulas such as those expressing ratios, time, and volume.

Example:

  • We need at least a 3:5 ratio of experienced to inexperienced players.
  • The clock flashed 12:00, so I knew there was a power outage.
  • She said her time was "1:12:39" just as her coach shouted "one hour, twelve minutes, and thirty-nine seconds!"


Colon: In Abbreviations

Colons function as dividers between page references, Bible citations, location and publisher.

Example:

  • Read John 1:10. (Chapter 1 verse 10)
  • Springfield: G C Merriman Co.


LINKS

Introduction for Site and Samples

Table of Contents Technical Writing with Style ( First Edition )

Samples from the Getting the Words Right section in the book

Samples from the Punctuation section in the book

Samples of Software File Formats and process descriptions from the Technical Research Assistant 2000

Samples of Compendium of Hardware and Communications Concepts from the Technical Research Assistant 2000

Your EMAIL comments and purchase requests are invited

Now Shipping an expanded
Technical Writing with Style
- SECOND EDITION -
For 2000

Book Pricing

Copyright 2000 Ken Lachnicht, reprinted with permission by
CHAMPIONS Management Support Services, Inc. All rights reserved.

Visit our

Enter the library through its Opening page

Return to top