Technical Writing Essentials Punctuation Guide 2018
Technical Writing Essentials Punctuation Guide 2018
This guide is provided to expand your knowledge of punctuation, its correct (as well
as incorrect) usage, and its stylistic benefits. You’re provided a definition and
exploration of each piece of punctuation, and then incorrect and correct examples,
with an explanation of the errors and some alternate solutions.
There are so many options available to you, which you can consider and appropriately
apply to your rhetorical situation and audience.
Comma: One of the most versatile pieces of punctuation is the comma. Too often, we
, think of commas simply in terms of right and wrong—correct and incorrect. Commas
certainly do have rules: they can be used in sentences to indicate a pause (and thus
emphasis), to separate items within a list, and to mark the place of a thousand in
numerals, among other functions. They shouldn’t connect two independent thoughts
without some kind of conjunction, but more on that later.
However, commas are by nature stylistic. They change the flow, the sound of how a
sentence, an idea is read and perceived. You can create a pause, mix up pacing,
extend a train of thought, or otherwise creatively alter the way your readers interact
with a piece of writing. Removing them can create feelings of restlessness and speed
up a sentence. None of these are about correctness—they’re about style and how you,
the writer, can control more than just word choice.
Numerals: Typically, when using large numbers (in the thousands and beyond), you
would include a comma to distinguish each group of three digits.
• Incorrect Example: Pull out a $1000 at the bank.
• Fix: Pull out a $1,000 at the bank.
o Another possibility is spelling out the numeral: Pull out a thousand
dollars at the bank. However, this might dependent on what style is
being employed, between ones like Chicago and APA or even an in-
house company style guide.
Oxford Comma: You knew this one had to be in here. Commas are placed between
items in lists, and for years there has been debate about whether one was needed
before the final conjunction in a list. The Oxford comma has been historically used in
certain styles like Chicago and MLA but not in others like AP and APA. However, in
recent years the Oxford comma has been added to those latter styles as well. The
general rule is if omitting the comma will cause confusion or misunderstanding, then
use it.
• Incorrect Example: I went to dinner with my parents, the Pope and Mother
Teresa.
• Fix: I went to dinner with my parents, the Pope, and Mother Teresa.
Colon: In the book Punctuate It Right, the author refers to the colon as the mark of
: expectation or addition (1). It’s like a road sign, an arrow pointing forward and
signaling to read on for relevant information.
Commonly speaking, colons are used to inform readers that what follows the mark
explains, develops, defines, or proves what came before. In sentences, they frequently
precede a list of items, introduce a quote, or set up an expansion or explanation of an
idea. Colons are also used to separate hours from minutes in time, chapters and verses
in scripture, and numbers in ratios.
How colons are used—what emphasis they place, where they’re located in a sentence,
and such—are stylistically up to you. They’re a more flexible punctuation mark than
you might think, especially with the more formal air that is normally associated with
them.
Semicolons are used at the end of sentences to show a pause, typically between two
independent clauses, that are more pronounced than a comma and signify that the two
are connected. They can also be used in a list that contains internal commas. Use this
punctuation mark when you want to create and emphasize a relationship between two
or more sentences and concepts.
Transitional: Semicolons are used between two independent clauses (as has been
established several times), including when those clauses are linked by a transitional
expression such as however, for example, thus, and so on.
• Incorrect Example: Varying opinions suggest this is not the case, however,
experts disagree with that.
• Fix: Varying opinions suggest this is not the case; however, experts disagree
with that.
Super-comma: Commas are usually the punctuation mark used in a list to divide up
its contents; however, sometimes semicolons can perform that function for lists
within lists. This use of semicolons is known as a super-comma. It makes clear where
the divides are.
• Incorrect Example: The new store has groceries, houseware, and electronics
on the first floor, clothing on the second, and books, music, and food on the
third.
Fix: The new store has groceries, houseware, and electronics on the first
floor; clothing on the second; and books, music, and food on the third.
Hyphen: Whether to hyphenate words together is a common concern for writers, new
- and experienced. Dictionaries and style guides vary on correct usage; however, the
silver lining there is that, outside of some core principles and conventions, decisions
can come down to stylistic choice. That might sound like a negative, but it gives you
more creative freedom as a writer.
Hyphens are used to join adjectival words and thus indicate that they have a
combined new meaning or that they are linked, to divide a word onto two lines in a
document, and to suggest a continuing or implied idea in a sentence. With hyphens,
you literally have the power to create new words and link ideas in ways that a reader
might never have read or considered before.
Mistakes tend to crop up when adverbs (or words functioning as such) are hyphenated
or when hyphens are used too frequently—as with any writing tool, oversaturation
will limit the its power.
Hyphen List: Include hyphens in a running list so long as the words being hyphenated
are connected to the same noun. This helps prevent misreading, as readers might not
pick up on the relationship as easily without the hyphens.
• Incorrect Example: The condo has two, three, and four-bedroom options
available.
• Fix: The condo has two-, three-, and four-bedroom options available.
Hyphenation: Whether a word uses a hyphen depends on the style guide being used
or, more likely, the dictionary being employed. The Chicago Manual of Style includes
a table that can be referenced for general use and rules. Check against your style
guide and use dictionaries like Merriam-Webster when unsure.
• Incorrect Example: Mr. Peterson was promoted to chief-of-staff, which was an
eye opener.
• Fix: Mr. Peterson was promoted to chief of staff, which was an eye-opener.
Em Dash: You might be more familiar with em dashes as a couple hyphens clustered
— together, as that’s historically how they’ve been signified. Some computer programs
will even create the dash from that setup. (For your reference, there are keyboard
shortcuts to create em dashes: for a Mac it’s “shift,” “option,” and hyphen, while for a
PC it’s “control,” “alt,” and the minus button.)
Of the three dash marks (the other two being hyphen and en dash), this is the longest
and the most versatile, with more options and creative license available to you.
Multiple Dashes: It’s best to play it safe and only use two dashes in a given sentence
to avoid confusion, for yourself and your readers. It also makes the sentence and ideas
drag on for too long.
• Incorrect Example: The court reached a verdict—guilty—which was
unexpected—the accused had one of the best lawyers in the country.
• Fix: The court reached a verdict—guilty; this was unexpected, as the accused
had one of the best lawyers in the country.
o Another possible fix: The court reached a verdict of guilty, which was
unexpected—the accused had one of the best lawyers in the country.
There are many possible ways to change the sentence to make it
correct, and each could have a slightly different emphasis and flow.
Other Punctuation: If the parenthetical statement within the em dashes were instead
surrounded by parentheses, then there would be a comma after the concluding
parenthesis. With em dashes, however, extra punctuation is not needed.
• Incorrect Example: Once she discovered the problem—it was a big one—, she
began to panic.
• Fix: Once she discovered the problem—it was a big one—she began to panic.
En Dash: Completing our exploration of dashes is the en dash, which is used with
– spans or ranges of numbers, dates, directions, and times. As with hyphens and em
dashes, there should be no spaces around the punctuation mark. (And as with the em
dash, there are specific keyboard shortcuts for making an en dash: for a Mac it’s
“option” and hyphen, while for a PC it’s “control” and the minus button.)
Here’s a professional tip for you: never use two or three or however many hyphens in
place of en or em dashes. This is an incorrect practice carried over from typewriters
days, when hyphens were the only available option on keyboards. This is seen as
unprofessional and dated, which is never a good way for your writing to be perceived.
Spelled Out: If you introduce a span of numbers with words like from and between,
don’t use an en dash. Rather, use to or and, respectively.
• Incorrect Example: The Civil War occurred between 1861–65.
• Fix: The Civil War occurred between 1861 and 1865.
Compound Adjectives: Most compound adjectives will simply use a hyphen to show
the connected nature of the words. However, when an element of that compound
adjective is open (in the example below, “Newbury Award”), change the hyphen to
an en dash.
• Incorrect Example: She is a Newbury Award-winning author.
• Fix: She is a Newbury Award–winning author.
Direction and Conflict: En dashes are used instead of hyphens between words that
indicate direction or conflict.
• Incorrect Example: The Libertarian-Democrat debate will be taking place in
the building next to the north-south railway.
• Fix: The Libertarian–Democrat debate will be taking place in the building
next to the north–south railway.
Apostrophe: Not to be confused with the figure of speech apostrophe, the
‘ punctuation mark is used grammatically to indicate possession, the omission of letters
or numbers, and plurals for individual letters.
Apostrophes are usually associated with contractions, which are steadily becoming
more accepted in various forms of writing, but there are less common applications
and more common mistakes, particularly with unexpected possessives and personal
pronouns.
Plurals with Single Letters: This use of the apostrophe clarifies that a plural is being
used for singular letters. In essentially all other cases you would not use an
apostrophe for plurals, included years (1980s).
• Incorrect Example: Mind your ps and qs. It’s a phrase that originated in the
mid-1800’s.
• Fix: Mind your p’s and q’s. It’s a phrase that originated in the mid-1800s.
However, quotation marks can also highlight and emphasize certain terms to readers,
often in an ironic sense. This usage is called scare quotes. If employed, the writer
must be clear on what feeling and intention—hence why such quotes are recurrently
preceded by the phrase so-called.
Another professional tip is to ensure that you use smart or “curly” quotation marks
rather than "straight"—the former is more modern and should be the default for, at the
very least, any kind of published work.
Song Title: Song titles should be placed within quotation marks—albums should be in
italics (though if the entire sentence is in italics, like the below example, then the
album wouldn’t be in italics to differentiate it from the other text).
• Incorrect Example: I love the song The Only One Who Gets Me from Charles
Kelley’s album, “The Driver.”
• Fix: I love the song “The Only One Who Gets Me” from Charles Kelley’s
album, The Driver.
Asterisk: No doubt you’ve read an advertisement that made a bold, enticing claim but
* then had a little star at the end of it. Then, in noticeably smaller text, there’s an
annotation, amending or clarifying the claim—or maybe it doesn’t even refer you to
anything. Asterisks are perceived like promises, committing that further exploration
and illumination will come.
As mentioned, asterisks are used to reference an annotation, though they can also
stand in for omitted writing—that you the writer have changed or have some further
comment to be made. Each of these have common errors, often due to where the
asterisk is place and what, if anything, it replaces.
Multiple Asterisks: Using a singular asterisk works fine so long as there is only one
reference or footnote on a given page. However, if multiple ones are used, then it
could get confusing as to what is being referred to; therefore, you should increase the
numbers of asterisks.
• Incorrect Example: The data suggest that we need to make radical changes to
our infrastructure.* We also have to alter our hiring policy to reflect modern
practices.* This is supported by the branch manager.*
• Fix: The data suggest that we need to make radical changes to our
infrastructure.* We also have to alter our hiring policy to reflect modern
practices.** This is supported by the branch manager.***
o An alternative solution would be to change the asterisks to a numbered
list: The data suggest that we need to make radical changes to our
infrastructure.1 We also have to alter our hiring policy to reflect
modern practices.2 This is supported by the branch manager.3
Omission: There are a number of options available for omitting parts of words. When
using asterisks, omission generally involves vowels more than consonants, but the
context should still be clear—but not too clear so as to render censorship pointless.
• Incorrect Example: My boss told me he “didn’t give a da*n” about my
excuses for failing.
• Fix: My boss told me he “didn’t give a d**n” about my excuses for failing.
o An alternative option for omission employs em dashes: My boss told
me he “didn’t give a d— —n” about my excuses for failing. Another
possibility is brackets if it’s quoted material, like the example: My boss
told me he “didn’t [care]” about my excuses for failing.
() Parenthesis: Several punctuation marks can set of parenthetical—meaning related or
supplementary—statements in sentences, which can include just single words or
fragments or even multiple sentences, and each one has a different feel. Commas can
enclose entire statements, and they largely feel neutral and matter-of-fact. Dashes are
more abrupt and better highlight and emphasize.
Parentheses suggest that the information contained within is complementary but not
necessary. They are stronger than a comma and—like dashes—do not grammatically
impact the surrounding sentence, a rule that often leads to unintentional mistakes.
Translations: Short translations of texts that are not quoted can be included in
parentheses. (If it is quoted, then it should be in brackets. Also, foreign words should
always be italicized.)
• Incorrect Example: My knowledge of Spanish is limited to hola [hello] and
adios [goodbye].
• Fix: Translations: My knowledge of Spanish is limited to hola (hello) and
adios (goodbye).
[] Bracket: Perhaps not as popular as parentheses, brackets are used in a similar
fashion, enclosing words or figures and separating them from the rest of a sentence as
a parenthetical statement. The distinction comes with where brackets are placed:
inside of quotes. They can also change elements of a quote, altering capitalization or,
as mentioned, adding information for clarification or expansion.
Most issues with brackets come in treating them as being more angular versions of
parentheses, which they are not. They’re certainly tied to parentheses, but they have
specific functions with quotes and changes to written materials.
Brackets in Parentheses: In the event that parentheses are required within parentheses,
brackets are then used instead.
• Incorrect Example: She toured the country and gave lectures (while
simultaneously publishing a book (2008)).
• Fix: She toured the country and gave lectures (while simultaneously
publishing a book [2008]).
Errors: The Latin term sic means “thus” or “so”; this indicates that a mistake has been
left in from an original quote and is not the fault of you, the writer. The word sic
should be italicized, but the enclosing brackets shouldn’t be—the inverse is used in
the below example.
• Incorrect Example: The representative’s statement said that “human error
were responsible.”
• Fix: The representative’s statement said that “human error were [sic]
responsible.”
... Ellipsis: Have you ever trailed off when unsure what to say next in a conversation or
presentation? The written equivalent of that is an ellipsis, or three periods one after
the other. Ellipses (the plural form) are used in sentences—often quotes—to signal
the omission of writing that is either superfluous or is understandable from context
clues, ensuring that only the most relevant information is presented.
However, ellipses can also be used to indicate incomplete thoughts (like the trailing
off previous mentioned), provide a brief pause, or suggest a nervous and awkward
silence.
Tone is an important part of writing, and tools like ellipses—and a number of other
punctuation marks mentioned and to be mentioned—aid in conveying this to readers.
Spacing: Microsoft Word and similar programs have automatic ellipses generators,
but the spacing is insufficient for some styles. AP accepts no spaces, but for other
styles like Chicago, type out the spaces between, before, and after the periods to form
clearer ellipses points.
• Incorrect Example: I didn’t want to say it … but you’ve left me no choice: I do
think the dress makes you look fat.
• Fix: I didn’t want to say it . . . but you’ve left me no choice: I do think the
dress makes you look fat.
Omission: Most styles advocate including a period before an ellipses that is followed
by a new sentence and capital. How the ellipses itself is formatted depends, but it’s
generally the case that if the word after the ellipses is capitalized, you should have a
period before said ellipses.
• Incorrect Example: Thoreau stated, “I learned . . . that if one advances
confidently in the direction of his dreams, . . . he will meet with . . . success . . .
He will put some things behind . . . In proportion as he simplifies his life, the
laws of the universe will appear less complex.”
• Fix: Thoreau stated, “I learned . . . that if one advances confidently in the
direction of his dreams, . . . he will meet with . . . success. . . . He will put
some things behind. . . . In proportion as he simplifies his life, the laws of the
universe will appear less complex.”
Period: Easily one of the most common punctuation marks, the period is used at the
. end of a sentence to show the conclusion of an idea or an abbreviation. Periods are
like stop signs, signaling a greater pause and concluding a complete idea and clause.
While texting and other online trends tend to no long use periods as such, most forms
of professional writing (business, scholarly, and such) still use periods as such.
Of course, most know what a period does, but it has some less well-known uses, and
its placement can be confusing when combined with other punctuation marks, leading
to an assortment of complications and errors.
Spacing: Back when typewriters were a major writing tool, two spaces were placed
after a period; today, however, a single space is more often preferred.
• Incorrect Example: The document was written on a typewriter. It’s amazing
how technology has changed since then. I can’t believe it.
• Fix: The document was written on a typewriter. It’s amazing how technology
has changed since then. I can’t believe it.
Abbreviations: Particular style guides ultimately determine what periods are included
with what abbreviations, but a loose, general rule is that periods are included in
lowercase and mixed-up (in terms of capitalization) abbreviations and removed for
all-uppercase ones.
• Incorrect Example: The F.B.I. found traces of Na.Cl. in the victim’s ears, and
he’s just been identified as Mr Alvin Armstrong, a Ph.D. professor of
sociology.
• Fix: The FBI found traces of NaCl in the victim’s ears, and he’s just been
identified as Mr. Alvin Armstrong, a PhD professor of sociology.
Exclamation Point: “He had a heart attack.” “He had a heart attack!” While both of
! these are grammatically accurate, one more successfully gets across the situational
distress and concern likely associated with it, and that is the one with the exclamation
point. Exclamation points are used at the end of sentences to signal excitement,
outcry, or at least greater emphasis.
Titular Exclamation: When the exclamation point is part of a title or proper noun,
then a comma should be used—as grammatically necessary.
• Incorrect Example: After spending years at Yahoo! he finally got the job he
wanted at Google.
• Fix: After spending years at Yahoo!, he finally got the job he wanted at
Google.
Question Mark: As its name would suggest, a question mark is used at the end of a
? sentence to indicate a direct question or to express uncertainty or doubt. Indirect
questions or requests may seem like they should end with questions marks, but such
would actually conclude with periods.
Common shortcomings with question marks emerge from placement adjacent to other
punctuation and whether it should be applied to a given statement.
Requests: Though phrased as a question, requests should actually end with a period
rather than a question mark.
• Incorrect Example: Would you run this over to our neighbor?
• Fix: Would you run this over to our neighbor.
Uncertainty: You can imply uncertainty by adding a question mark into text to
suggest following up and clarifying information. Use parentheses for regular text and
brackets for quotes. Some authorities remove the space before the question mark,
making it part of the uncertain word, while others are more inclined to have a space to
allow for better flow. Choose whichever fits your appropriate style guide.
• Incorrect Example: The doctor advised me to only take three [?] Aspirin a
day.
• Fix: The doctor advised me to only take three (?) Aspirin a day.
Ampersand: Most people are familiar with ampersands from names like AT&T and
& brands like Dungeons & Dragons. It is used to represent the conjunction and,
commonly with business names and with document sources in scholarly and other
forms of formal writing.
Some style guides advocate ampersands and other recommend spelling out the and.
Be clear on what your specific company uses. When it is used with abbreviated
business names or common expressions, do not include spaces around the ampersand.
Citation: Correct citation methods depend on the style being employed. Chicago and
MLA would have you spell out the and (as well as use the Oxford comma), while
APA is more inclined toward ampersands without the comma, as seen above. Use the
appropriate style for the business or genre.
• Incorrect Example: Studies suggest that the current method for creating
nuclear power could be made more efficient (Smith, Jones, & Brown).
• Fix: Studies suggest that the current method for creating nuclear power could
be made more efficient (Smith, Jones & Brown).
Business Names: When business names (that are themselves abbreviations) include
an ampersand, no spaces should separate the letters and ampersand.
• Incorrect Example: My phone’s dead—guess it’s time to visit the AT & T
store.
• Fix: My phone’s dead—guess it’s time to visit the AT&T store.
Slash: The slash is not commonly used outside of informal communication. Almost
/ everyone who’s ever sent a text message has used “and/or” to suggest either or both
of stated possibilities. However, slashes are used in more formal and professional
spheres between other alternatives (functioning similar to the word or), as well as
with fractions, ratios, and line breaks in flowing text for poetry and musical lyrics.
There are two forms of slashes: forward and backward. They are not interchangeable
and will be distinguished with other common mistakes associated with slashes.
Poetry and Music: Poetic and musical line breaks are signaled by slashes. New lines
are capitalized, and the slash should have spaces on each side of it.
• Incorrect Example: Robert Frost in his poem “The Road Not Taken” wrote, “I
took one less traveled by, and that has made all the difference.”
• Fix: Robert Frost in his poem “The Road Not Taken” wrote, “I took one less
traveled by, / And that has made all the difference.”
Normal Spacing: When in doubt, don’t include spaces around slashes. There are
certain exceptions listed in Chicago, and there should be spaces when suggesting line
breaks in poetry (as seen in the previous example), but generally spaces aren’t
needed. Definitely do not have a space after a slash and not one before—commit to
no spaces or including spaces; in whichever case, be consistent.
• Incorrect Example: You could go to the mall and get a pretzel / an ice cream
cone.
• Fix: You could go to the mall and get a pretzel/an ice cream cone.