Technical Communication
Technical Communication
Inter office
relationships depend on communication to provide information where needed.
Without enough communication people are left hanging on their personal
assumptions. Too much communication can leave people rolling in their own excess
verbage.
In an inner office communication this could easily look something like this:
2. Meeting outline:
d. Brainstorm solutions
e. Solution discussions
Inner office communications determines whether or not the work gets done, how
well it gets done, and who does it. If communication is inadequate or non-existent,
jobs suffer, clients become unhappy, and businesses fail.
Offices with great communications skills require fewer people to accomplish the
same tasks, are far more efficient, and provide exemplary customer service
because there is no lag in communicating needs. This simple difference results in
better profit margins, higher quality product, and speedier service. Ultimately,
communication determines the success or failure of any business.
• Inquiry letters
• Complaint and adjustment letters
• Application letters
• Resumes
You can access examples of these types of business correspondence from the
individual sections in which they are discussed.
You can see a commercial offering of a wide variety of sample business letters at:
Types and Contexts This section focuses on the inquiry letter. The inquiry letter is
useful when you need information, advice, names, or
Contents and directions. Be careful, however, not to ask for too much
Organization information or for information that you could easily obtain in
some other way, for example, by a quick trip to the library.
Example 2: Questions
Frame Nonfram
about hardware support for Plain
s es
Red Hat Linux
This section discusses general format of business letters, shows you the four common business-letter format
discusses some basic guidelines for writing style in business letters.
ges
Here are some relevant websites on business communication:
ter
• Business Letter Writing. A useful site maintained by Patrick Burne, a retired business communication consulta
etter
e right Heading. The heading contains the writer's address and the date of the letter. The writer's name is not inclu
and only a date is needed in headings on letterhead stationery.
evious
nce Inside address. The inside address shows the name and address of the recipient of the letter. This informat
aphs helps prevent confusion. Also, if the recipient has moved, the inside address helps to determine what to do w
letter. In the inside address, include the appropriate title of respect of the recipient; and copy the name of th
ntalize" company exactly as that company writes it. When you do have the names of individuals, remember to addre
them appropriately: Mrs., Ms., Mr., Dr., and so on. If you are not sure what is correct for an individual, try to
cs at out how that individual signs letters or consult the forms-of-address section in a dictionary.
Salutation. The salutation directly addresses the recipient of the letter and is followed by a colon (except wh
er
friendly, familiar, sociable tone is intended, in which case a comma is used). Notice that in the simplified
letter format, the salutation line is eliminated altogether. If you don't know whether the recipient is a man or
ant
woman, the traditional practice has been to write "Dear Sir" or "Dear Sirs" — but that's sexist! To avoid this
problem, salutations such as "Dear Sir or Madame," "Dear Ladies and Gentlemen," "Dear Friends," or "Dear P
news in have been tried — but without much general acceptance. Deleting the salutation line altogether or inserting "
s Whom It May Concern" in its place, is not ordinarily a good solution either — it's impersonal.
ipients'
The best solution is to make a quick, anonymous phone call to the organization and ask for a name; Or, addr
the salutation to a department name, committee name, or a position name: "Dear Personnel Department," "
Recruitment Committee," "Dear Chairperson," "Dear Director of Financial Aid," for example.
Figure 1-1. Standard components of a business letter. In this example, the block letter format is used.
Subject or reference line. As shown in the order letter, the subject line replaces the salutation or is include
it. The subject line announces the main business of the letter.
ses
Body of the letter. The actual message of course is contained in the body of the letter, the paragraphs betw
the salutation and the complimentary close. Strategies for writing the body of the letter are discussed in the
onbusiness-correspondence style.
Complimentary close. The "Sincerely yours" element of the business letter is called the complimentary clos
Other common ones are "Sincerely yours," "Cordially," "Respectfully," or "Respectfully yours." You can design
own, but be careful not to create florid or wordy ones. Notice that only the first letter is capitalized, and it is
followed by a comma.
Signature block. Usually, you type your name four lines below the complimentary close, and sign your nam
between. If you are a woman and want to make your marital status clear, use Miss, Ms., or Mrs. in parenthe
before the typed version of your first name. Whenever possible, include your title or the name of the position
hold just below your name. For example, "Technical writing student," "Sophomore data processing major," o
"Tarrant County Community College Student" are perfectly acceptable.
End notations. Just below the signature block are often several abbreviations or phrases that have importan
functions.
• Initials. The initials in all capital letters in Figure 1-1 are those of the writer of the letter, and the ones in low
letters just after the colon are those of the typist.
• Enclosures. To make sure that the recipient knows that items accompany the letter in the same envelope, us
indications as "Enclosure," "Encl.," "Enclosures (2)." For example, if you send a resume and writing sample w
your application letter, you'd do this: "Encl.: Resume and Writing Sample." If the enclosure is lost, the recipi
know.
• Copies. If you send copies of a letter to others, indicate this fact among the end notations also. If, for examp
were upset by a local merchant's handling of your repair problems and were sending a copy of your letter to
Better Business Bureau, you'd write this: "cc: Better Business Bureau." If you plan to send a copy to your law
write something like this: "cc: Mr. Raymond Mason, Attorney."
Following pages. If your letter is longer than one page, the heading at the top of subsequent pages can be
handled in one of the following ways:
Ex
of following-page header format.
If you use letterhead stationery, remember not to use it for subsequent pages. However, you must use blank
of the same quality, weight, and texture as the letterhead paper (usually, letterhead stationery comes with
matching blank paper).
Which of these formats to use depends on the ones commonly used in your organization or the situation in w
you are writing. Use the simplified letter if you lack the name of an individual or department to write to.
State the main business, purpose, or subject matter right away. Let the reader know from the very fir
sentence what your letter is about. Remember that when business people open a letter, their first concern is
know what the letter is about, what its purpose is, and why they must spend their time reading it. Therefore,
round-about beginnings. If you are writing to apply for a job, begin with something like this: "I am writing to
for the position you currently have open...." If you have bad news for someone, you need not spill all of it in
first sentence. Here is an example of how to avoid negative phrasing: "I am writing in response to your lette
July 24, 1997 in which you discuss problems you have had with an electronic spreadsheet purchased from ou
company." Figure 1-2 shows an additional example.
Figure 1-2. State the main purpose or business of the letter right away. The problem version just starts flailin
away from the very outset. The revised version at least establishes the purpose of the letter (and then starts
flailing).
If you are responding to a letter, identify that letter by its subject and date in the first paragraph
sentence. Busy recipients who write many letters themselves may not remember their letters to you. To avo
problems, identify the date and subject of the letter to which you respond:
I have just received your August 4, 19XX letter in which you list
names and other sources from which I can get additional
information
on the manufacture and use of plastic bottles in the soft-drink
industry....
Keep the paragraphs of most business letters short. The paragraphs of business letters tend to be shor
some only a sentence long. Business letters are not read the same way as articles, reports, or books. Usually
are read rapidly. Big, thick, dense paragraphs over ten lines, which require much concentration, may not be
carefully — or read at all.
To enable the recipient to read your letters more rapidly and to comprehend and remember the important fa
ideas, create relatively short paragraphs of between three and eight lines long. In business letters, paragraph
are made up of only a single sentence are common and perfectly acceptable. Throughout this section, you'll
examples of the shorter paragraphs commonly used by business letters.
"Compartmentalize" the contents of your letter. When you "compartmentalize" the contents of a busine
letter, you place each different segment of the discussion — each different topic of the letter — in its own
paragraph. If you were writing a complaint letter concerning problems with the system unit of your personal
computer, you might have these paragraphs:
Study each paragraph of your letters for its purpose, content, or function. When you locate a paragraph that
more than one thing, consider splitting it into two paragraphs. If you discover two short separate paragraphs
do the same thing, consider joining them into one.
Provide topic indicators at the beginning of paragraphs. Analyze some of the letters you see in this sec
terms of the contents or purpose of their individual paragraphs. In the first sentence of any body paragraph
business letter, try to locate a word or phrase that indicates the topic of that paragraph. If a paragraph discu
your problems with a personal computer, work the word "problems" or the phrase "problems with my person
computer" into the first sentence. Doing this gives recipients a clear sense of the content and purpose of eac
paragraph. Here is an excerpt before and after topic indicators have been incorporated:
List or itemize whenever possible in a business letter. Listing spreads out the text of the letter, making
easier to pick up the important points rapidly. Lists can be handled in several ways, as explained in the sectio
lists. For examples of lists in business correspondence, see Figure 1-1, the inquiry letter, and order letter.
Place important information strategically in business letters. Information in the first and last lines of
paragraphs tends to be read and remembered better. Information buried in the middle of long paragraphs is
overlooked or forgotten. Therefore, place important information in high-visibility points. For example, in appl
letters which must convince potential employers that you are right for a job, locate information on appealing
qualities at the beginning or end of paragraphs for greater emphasis. Place less positive or detrimental inform
in less highly visible points in your business letters. If you have some difficult things to say, a good (and hon
strategy is to de-emphasize by placing them in areas of less emphasis. If a job requires three years of exper
and you only have one, bury this fact in the middle or the lower half of a body paragraph of the application le
The resulting letter will be honest and complete; it just won't emphasize weak points unnecessarily. Here are
examples of these ideas:
Find positive ways to express bad news in your business letters. Often, business letters must convey
news: a broken computer keyboard cannot be replaced, or an individual cannot be hired. Such bad news can
conveyed in a tactful way. Doing so reduces the chances that business relations with the recipient of the bad
will end. To convey bad news positively, avoid such words as "cannot," "forbid," "fail," "impossible," "refuse,"
"prohibit," "restrict," and "deny" as much as possible. The first versions of the example sentences below are
phrased in a rather cold and unfriendly negative manner; the second versions are much more positive, cordia
tactful:
Problem: Because of the amount of information you request in your
letter, simply cannot help you without seriously disrupting
my work schedule.
Focus on the recipient's needs, purposes, or interests instead of your own. Avoid a self-centered foc
on your own concerns rather than those of the recipient. Even if you must talk about yourself in a business le
great deal, do so in a way that relates your concerns to those of the recipient. This recipient-oriented style is
called the "you-attitude," which does not mean using more you's but making the recipient the main focus of
letter.
Avoid pompous, inflated, legal-sounding phrasing. Watch out for puffed-up, important-sounding langua
This kind of language may seem business-like at first; it's actually ridiculous. Of course, such phrasing is app
necessary in legal documents; but why use it in other writing situations? When you write a business letter, p
yourself as a plain-talking, common-sense, down-to-earth person (but avoid slang). Check out Figure 1-3 for
serious dose of bureaucratese.
Figure 1-3. Avoid pompous, officious-sounding writing. Not only is the tone of the problem version offensive,
nearly twice as long as the revised version!
Give your business letter an "action ending" whenever appropriate. An "action-ending" makes clear w
the writer of the letter expects the recipient to do and when. Ineffective conclusions to business letters often
with rather limp, noncommittal statements such as "Hope to hear from you soon" or "Let me know if I can be
any further assistance." Instead, or in addition, specify the action the recipient should take and the schedule
that action. If, for example, you are writing a query letter, ask the editor politely to let you know of his decis
at all possible in a month. If you are writing an application letter, subtlely try to set up a date and time for an
interview. Here are some examples:
Interested in courses related to this page or a printed version? See Return to the main menu of this online textbook for technical writ
the resources page.
Complaint Letters This section covers two closely related types of business
letters: complaint letters, which request compensation for
Adjustment Letters problems with purchases or services, and adjustment letters,
which are the responses to complaint letters.
Complaint Letters
Adjustment Letters
mon This section focuses on the application letter (sometimes called a "cover letter"), which together with the
s of resume is often called the "job package." You may already have written one or both of these employment
catio seeking documents. That's okay. Read and study this section, and then apply the guidelines here to the
ters resumes and application letters you have created in the past.
mon This section presents many different ways to design and write application letters. Nothing here is trying to
ons force you into one design. You design your own letter using whatever you find here that is useful and any
other sources you know of.
catio
ters In many job applications, you attach an application letter to your resume. Actually, the letter
comes before the resume.
ducto
The role of the application letter is to draw a clear connection between the job you are seeking and your
graph qualifications listed in the resume. To put it another way, the letter matches the requirements of the job
with your qualifications, emphasizing how you are right for that job. The application letter is not a lengthy
body summary of the resume — not at all. It selectively mentions information in the resume, as appropriate.
graph
Be sure to check out the example application letters accompanying this chapter:
grou
etails Example application letter 2: Science editorship Frames Nonframes Plain
e
catio Example application letter 3: Database
Frames Nonframes Plain
ter programmer
klist
Example application letter 4: Quality assurance
Frames Nonframes Plain
manager
mon
ems
Example application letter 5: Programmer/analyst Frames Nonframes Plain
catio
ters For related matters:
• See the section on resumes for the companion to this section.
To begin planning your letter, decide which type of application letter you need. This decision is in part
on
based on requirements that employers may have, and in part based on what your background and
ted employment needs are. In many ways, types of application letters are like the types of resumes. The type
ses of application letters can be defined according to amount and kind of information:
• Objective letters — One type of letter says very little: it identifies the position being sought, indicat
an interest in having an interview, and calls attention to the fact that the resume is attached. It als
mentions any other special matters that are not included on the resume, such as dates and times
when you are available to come in for an interview. This letter does no salesmanship and is very
brief. (It may represent the true meaning of "cover" letter.)
• Highlight letters — Another type of application letter, the type you do for most technical writing
courses, tries to summarize the key information from the resume, the key information that will
emphasize that you are a good candidate for the job. In other words, it selects the best information
from the resume and summarizes it in the letter — this type of letter is especially designed to make
the connection with the specific job.
How do you know which to write? For most technical-writing courses, write the highlight letter. However, i
"real-life" situations, it's anybody's guess. Try calling the prospective employer; study the job
advertisement for clues.
As for the actual content and organization of the paragraphs within the application letter (specifically
the highlighttype of application letter), consider the following comon approaches.
Introductory paragraph. That first paragraph of the application letter is the most important; it sets
everything up — the tone, focus, as well as your most important qualification. A typical problem in the
introductory paragraph involves diving directly into work and educational experience. Bad idea! A better
idea is to do something like the following:
• Indicate the source of your information about the job — newspaper advertisement, a personal
contact, or other.
• State one eye-catching, attention-getting thing about yourself in relation to the job or to the
employer that will cause the reader to want to continue.
And you try to do all things like these in the space of very short paragraph — no more than 4 to 5 lines of
the standard business letter. (And certainly, please don't think of these as the "right" or the "only" things
put in the introduction to an application letter.)
Main body paragraphs. In the main parts of the application letter, you present your work experience,
education, training — whatever makes that connection between you and the job you are seeking.
Remember that this is the most important job you have to do in this letter — to enable the reader see the
match between your qualifications and the requirements for the job.
• Functional approach — This one presents education in one section, and work experience in the othe
If there were military experience, that might go in another section. Whichever of these section
contains your "best stuff" should come first, after the introduction.
• Thematic approach — This one divides experience and education into groups such as "managemen
"technical," "financial," and so on and then discusses your work and education related to them in
separate paragraphs.
If you read the section on functional and thematic organization of resumes, just about everything said the
applies here. Of course, the letter is not exhaustive or complete about your background — it highlights ju
those aspects of your background that make the connection with the job you are seeking.
Com
on sections of application letters. You can organize the letter thematically or functionally the same way th
you can the resume.
Another section worth considering for the main body of the application letter is one in which you discuss
your goals, objectives — the focus of your career — what you are doing, or want to do professionally. A
paragraph like this is particularly good for people just starting their careers, when there is not much to pu
in the letter. Of course, be careful about loading a paragraph like this with "sweet nothings." For example
am seeking a challenging, rewarding career with an dynamic upscale company where I will have ample
room for professional and personal growth" — come on! give us a break! Might as well say, "I want to be
happy, well-paid, and well-fed."
Closing paragraph. In the last paragraph of the application letter, you can indicate how the prospective
employer can get in touch with you and when are the best times for an interview. This is the place to urge
that prospective employer to contact you to arrange an interview.
One of the best ways to make an application letter great is to work in details, examples, specifics about
related aspects of your educational and employment background. Yes, if the resume is attached, readers
can see all that details there. However, a letter that is overly general and vague might generate so little
interest that the reader might not even care to turn to the resume.
In the application letter, you work in selective detail that makes your letter stand out, makes it memorabl
and substantiates the claims you make about your skills and experience. Take a look at this example, whi
is rather lacking in specifics:
• Readability and white space — Are there any dense paragraphs over 8 lines? Are there comfortable
1-inch to 1.5-inch margins all the way around the letter? Is there adequate spacing between
paragraph and between the components of the letter?
• Page fill — Is the letter placed on the page nicely: not crammed at the top one-half of the page; no
spilling over to a second page by only three or four lines?
• General neatness, professional-looking quality — Is the letter on good quality paper, and is the cop
clean and free of smudges and erasures?
• Proper use of the business-letter format — Have you set up the letter in one of the standard
business-letter formats? (See the references earlier in this chapter.)
• Overt, direct indication of the connection between your background and the requirements of the
job — Do you emphasize this connection?
• A good upbeat, positive tone — Is the tone of your letter bright and positive? Does it avoid soundin
overly aggressive, brash, over-confident (unless that is really the tone you want)? Does your letter
avoid the opposite problem of sounding stiff, overly reserved, stand-offish, blase, indifferent?
• A good introduction — Does your introduction establish the purpose of the letter? Does it avoid divi
directly into the details of your work and educational experience? Do you present one little
compelling detail about yourself that will cause the reader to want to keep reading?
• A good balance between brevity and details — Does your letter avoid becoming too detailed (makin
readers less inclined to read thoroughly)? Does your letter avoid the opposite extreme of being so
general that it could refer to practically anybody?
• Lots of specifics (dates, numbers, names, etc.) — Does your letter present plenty of specific detail
but without making the letter too densely detailed? Do you present hard factual detail (numbers,
dates, proper names) that make you stand out as an individual?
• A minimum of information that is simply your opinion of yourself — Do you avoid over-reliance on
information that is simply your opinions about yourself. For example, instead of saying that you
"work well with others," do you cite work experience that proves that fact but without actually stati
it?
• Grammar, spelling, usage — And of course, does your letter use correct grammar, usage, and
spelling?
Interested in courses related to this page Return to the main menu of this online
or a printed version? See textbook for technical writing.
the resources page.
Body now?
Detail start with who you are, what your background is, what the potential
formats employer is looking for, and what your employment goals are — not with
from some prefab design. Therefore, use this chapter to design your own
Special resume; browse through the various formats; play around with them until
Section you find one that works for you.
s in
Resume Be sure and check out the example resumes accompanying this chapter:
s
Nonframe
Example resume 1: Veterinary assistant Frames Plain
Highligh s
ts,
summar Example resume 2: LAN system Nonframe
y Frames Plain
administrator s
section
Main
Index
Print
Version
Related
Courses
Basic sections of a resume. Whichever format you use, the information
generally divides up as shown here.
Sections in Resumes
Resumes can be divided into three sections: the heading, the body, and the
conclusion. Each of these sections has fairly common contents.
Heading. The top third of the resume is the heading. It contains your name,
phone numbers, address, and other details such as your occupation, titles,
and so on. Some resume writers include the name of their profession,
occupation, or field. In some examples, you'll see writers putting things like
"CERTIFIED PHYSICAL THERAPIST" very prominently in the heading.
Headings can also contain a goals and objectives subsection and a
highlights subsection. These two special subsections are described later in
"Special Sections in Resumes."
Conclusion. In the final third or quarter of the resume, you can present
other related information on your background. For example, you can list
activities, professional associations, memberships, hobbies, and interests.
At the bottom of the resume, people often put "REFERENCES AVAILABLE ON
REQUEST" and the date of preparation of the resume. At first, you might
think that listing nonwork and personal information would be totally
irrelevant and inappropriate. Actually, it can come in handy — it
personalizes you to potential employers and gives you something to chat
while you're waiting for the coffee machine or the elevator. For example, if
you mention in your resume that you raise goats, that gives the interviewer
something to chat with you about during those moments of otherwise
uncomfortable silence.
To begin planning your resume, decide which type of resume you need. This
decision is in part based on requirements that prospective employers may
have, and in part based on what your background and employment needs
are.
• Detailed resumes: This type provides not only dates, titles, and
names, but also details about your responsibilities and statements
about the quality and effectiveness of your work. This is the type
most people write, and the type that is the focus of most technical-
writing courses. The rest of the details in this section of this chapter
focus on writing the detailed resume.
General layout. Look at resumes in this book and in other sources strictly
in terms of the style and placement of the headings, the shape of the text
(the paragraphs) in the resumes, and the orientation of these two elements
with each other. Some resumes have the headings centered; others are on
the left margin. Notice that the actual text — the paragraphs — of resumes
typically does not extend to the far left and the far right margins. Full-length
lines are not considered as readable or scannable as the shorter ones you
see illustrated in the examples in this book.
Notice that many resumes use a "hanging-head" format. In this case, the
heading starts on the far left margin while the text is indented another inch
or so. This format makes the heading stand out more and the text more
scannable. Notice also that in some of the text paragraphs of resumes,
special typography is used to highlight the name of the organization or the
job title.
Detail formats. You have to make a fundamental decision about how you
present the details of your work and education experience. Several
examples of typical presentational techniques are shown below. The
elements you work with include:
There are many different ways to format this information. It all depends on
what you want to emphasize and how much or how little information you
have (whether you are struggling to fit it all on one page or struggling to
make it fill one page). Several different detail formats are shown above.
Here are some ideas for special resume sections, sections that emphasize
your goals or qualifications.
Objectives, goals. Also found on some resumes is a section just under the
heading in which you describe what your key goals or objectives are or what
your key qualifications are. Some resume writers shy away from including a
section like this because they fear it may cause certain employers to stop
reading, in other words, that it limits their possibilities. A key-qualifications
section is similar to a highlights section, but shorter and in paragraph rather
than list form.
Amplifications page. Some people have a lot of detail that they want to
convey about their qualifications but that does not fit well in any of the
typical resume designs. For example, certain computer specialists can list
dozens of hardware and software products they have experience with — and
they feel they must list all this in the resume. To keep the main part of the
resume from becoming unbalanced and less readable, they shift all of this
detail to an amplications page. There, the computer specialist can
categorize and list all that extensive experience in many different operating
systems, hardware configurations, and software applications. Similarly,
some resume writers want to show lots more detail about the
responsibilities and duties they have managed in past employment. The
standard formats for resume design just do not accommodate this sort of
detail; and this is where the amplifications page can be useful.
Amplifications page in a resume. If you have lots of detail about what you
know, this approach on page 2 of the resume may work. On the first page of
this resume, the writer divides the presentation into experience and
education sections and takes a chronological approach to each. On the first
page, he only provides company names, job titles, dates, and discussion of
duties.
As you plan, write, or review your resume, keep these points in mind:
• White space. Picture a resume crammed with detail, using only half-
inch margins all the way around, a small type size, and only a small
amount of space between parts of the resume. Our prospective
employer might be less inclined to pore through that also. "Air it out!"
Find ways to incorporate more white space in the margins and
between sections of the resume. Again, the "hanging-head" design is
also useful.
• Special format. Make sure that you use special format consistently
throughout the resume. For example, if you use a hanging-head style
for the work-experience section, use it in the education section as
well.
• Terse writing style. It's okay to use a rather clipped, terse writing
style in resumes — up to a point. The challenge in most resumes is to
get it all on one page (or two if you have a lot of information to
present). Instead of writing "I supervised a team of five technicians..."
you write "Supervised a team of five technicians..." However, you
don't leave out normal words such as articles.
• Page fill. Do everything you can to make your resume fill out one full
page and to keep it from spilling over by 4 or 5 lines to a second
page. At the beginning of your career, it's tough filling up a full page
of a resume. As you move into your career, it gets hard keeping it to
one page. If you need a two-page resume, see that the second page
is full or nearly full.
When you've done everything you can think of to finetune your resume, it's
time to produce the final copy — the one that goes to the prospective
employer. This is the time to use nice paper and a good printer and
generally take every step you know of to produce a professional-looking
resume. You'll notice that resumes often use a heavier stock of paper and
often an off-white or non-white color of paper. Some even go so far as to
use drastically different colors such as red, blue, or green, hoping to catch
prospective employers' attention better. Proceed with caution in these
areas!