Professional Documents
Culture Documents
Writing
Usman Baba
2
§ Accuracy
– Technical communication conveys
information that is crucial to the
success of real-world tasks.
Effective Technical
Communication – It has a very specific use to the reader.
(cont’d.) – It results in decisions being made or
machinery being constructed.
– Therefore technical documents must be
highly accurate.
9
§ Clarity
§ Equally important to technical
communication is clarity.
§ If a document such as an instruction set or
Effective Technical a report does not contain clear information,
Communication the reader cannot comprehend the writer’s
(cont’d.) intent or complete the necessary task.
§ Clear writing will prevent confusion and
give the audience direction on completion
of the task.
10
§ Conciseness
§ Finally, technical communication must
be concise.
§ Technical writing is characterized by
Effective Technical direct language that gets right to the
Communication point.
(cont’d.) § It avoids flowery descriptions that can
obscure the meaning
§ All technical communication should
include everything the reader or listener
needs in an organized, no frills fashion.
11
§ To be an effective technical
communicator, the writer must consider
the purpose of the document, the
Purpose, intended audience, and the context in
Audience which the writer is writing or presenting.
Analysis, and § If the audience cannot apply, or
Context understand the information presented,
then the author has failed to meet his or
her objective.
12
§ Purpose
§ The first consideration of any technical
communicator should be the purpose of the
document or presentation.
§ Technical communication is generally designed
Purpose, to be practical and useful.
Audience § The writer must know the end goal of the
communication in order to deliver the message
Analysis, and effectively.
Context (cont’d.) § Purpose determines format.
§ Each type of document used in technical and
business writing follows a specific format.
§ Purpose also determines the type of information
that is included in the document or presentation
§ Audience Analysis
– When a project begins, a technical
communicator also must consider the
audience.
§ Audience Needs
§ A technical communicator also will take time to
consider the specific needs of the audience.
§ What is the information going to be used for?
Purpose,
§ What does the audience need to do with it?
Audience
Analysis, and
Context (cont’d.) • International Audiences
In today’s global economy, the technical
communicator should remember that he or she
does not write for a single culture or ethnic group.
§ Analyze readers to meet their needs; not all terms may need to
be defined.
Audience § Whereas, if the target reader is familiar with the term, but there
are various interpretations, then it should be defined as it
Analysis applies to the context of the document.
§ Identifying the needs of the target reader will save time when
the writing process actually begins because the writing will
focus on precisely what the reader needs in order to understand
the terms in the context of the overall document.
20
Writing for
International § Idioms are words or phrases that have cultural meanings,
but the meaning of such phrases cannot be derived from
Audiences – the words themselves, such as: “She’s flying high.’’ In
Cont’d America, that phrase means she is feeling good, but a
non-native speaker may not know what is implied by
‘flying high.’
§ A writer cannot shy away from using technical terms when they
are appropriate, and yet a writer cannot assume that the reader
will know what the term means from personal knowledge or the
context of the sentence.
§ Analyze the term from the perspective of someone not familiar with it by
using common journalism questions: who, what, when, how, and why. This
will prompt examination from every angle in order to accurately reflect
details about the term, beyond just the physical description.
Writing § Provide historical insight about the term, as it will help the reader find
greater understanding, without overwhelming the reader with too much
Process – information.
Cont’d § Think beyond the place and time of the writing of the description so that the
reader can see if the object will evolve or change going forward.
§ Keep the scope of the definition in relation to what the reader will find of
value when reviewing the rest of the document.
Forms of Technical Writing
§ As Mentioned earlier, technical, business and professional
Forms of writing overlap when it comes to writing responsibilities
(bcc) Line q No-one except for the sender and the person in the bcc line
knows this person is included in the email.
qOften the most overlooked or dismissed part of an email. A
subject line establishes priority in an inbox. As the reader scans
over the numerous mails every day, the subject line often
determines what will be read now versus later, or maybe never
at all.
The Subject qWhen determining what to include in the subject line, the best
Line rule of thumb is to be specific; tell the reader exactly what the
email contains.
Attachments
Attached is the new hiring process document, which contains the new hiring form and
directions for using that form. This process is to be implemented for all new hires
beginning September 21, 2007. Please print or save this document for future use or
reference.
qWhen replying only to the sender of an email, restrict
information in the reply to only that which pertains to the
subject of the email.
Replying qDo not bring up a whole new subject just because that person is
someone who might know that information.
qOut of respect, and to minimize unnecessary email, restrict the
use of the “Reply All” button for only when the response
contains essential, additional or explanatory material to the
original email that is vital for all recipients to know.
qTo use this feature when simply saying “thank you”, “will do”
Reply All or “sounds good” creates unnecessary email traffic on a server
and clogs in-boxes with emails that have no value.
an Interoffice qTo help meet these standards, the following guidelines explain
Memo the general conventions of writing an interoffice memo.
qIn hard copy, this is the date the memo is actually distributed. If
the memo is composed at the end of one day, but not circulated
until the next, the date on the memo should be the circulation
date.
Date Line qIn email, the electronic system will automatically swap the date
and time the email was sent, so this line is generally not part of
the actual email memo.
qIn hard copy, this line can be general, such as “All floor
managers”, “All night shift employees”, or “All full time
faculty”.
qTo Line can be more general here because copies are made and
distributed physically, which means specific names are
generally not needed on the memo itself when referring to a
To Line group of people.
From Line qIf the department is used, then a clear delineation of the
manager in that department should be included, such as:
q The more descriptive the subject line, the more likely the
memo will be read and acted on. If the subject line is vague or
too general, as in “Expense Report Procedures”, the memo may
be dismissed.
qThe body of a memo has an expected format and structure.
Readers expect to see an introduction, a body and a conclusion.
The end of the semester checklist given below must be completed and
signed by all instructors before checking out for summer break on May
15.
§ Details or further explanation should follow the introduction.
This should be restricted to only background or details that are
relevant to the purpose of sending out the memo in the first
Body – Cont’d place.
qAn interoffice memo generally runs no longer than one page. A
memo that runs a full page or longer will most likely be
skimmed or not read in its entirety.
Body – Cont’d qIt is courteous to end a memo with contact information in case
readers have questions or need further information.
Business Letters
qBusiness letters focus on relationships. They are formal
correspondences that facilitate communication within a
company or between a company and outside customers,
partners, potential clients, or other stakeholders.
Adjustment
Letter qAs we shall see later, there are certain ways to write good news
and bad news letters, while still maintaining a positive rapport
and hopefully the business of the customer.
qAs with any documentation, effective business letters address a
particular audience and purpose first.
qIn other words, the first place to start any type of letter writing
is to get to know the person or group of people the letter will
be addressed to so that correspondence can be personalized.
Personalizing a letter begins with specific names. Letters that
address a person using the person’s name, for example, Ms
Gonzales, versus a generic opening, such as Dear Customer, are
Audience much more effective in grabbing reader’s attention.
qIf a letter is a part of mass mailing, then that audience should be
broken down into smaller, more manageable groups such as by
region, gender and profession. By so doing, letters can be
revised according to each of the smaller groups of people, thus
making them much more personal and on target with the
intended population.
qDefining the purpose of the letter is the next step in addressing
the intended audience in an appropriate manner:
Formality amount of time, and the writer is certain that the recipient would
prefer to be addressed by the first name.
All readers have time to read every piece of information all the
way through; therefore, it is important that the following
formats are used so that readers are comfortable and know
exactly what they have in their hands.
qAll correspondence that comes from a company should appear
on a company’s printed letterhead.
Structure These paragraphs are generally short and concise, providing only
necessary information and no extraneous details.
This goes back to the idea that people in the workplace are usually
busy and do not have time to wade through details other than what
directly relates to the immediate order of business.
qClosing paragraph. Every business letter should conclude with
a closing paragraph that relates the purpose of the letter and
provides the sender’s contact information.
Cont’d
qSignature block. After the complementary close, space down
four lines and then type the name of the sender. The four-space
block above the name is for a signature.
qBlock Style refers to how the information is set up and typed on
the company’s letterhead.
Cover Letters qBody paragraphs. These can be used either to pitch sales for
the product or service or to provide readers with more details
– Cont’d about the document or product they received.
Letters – letter should be professional and formal, and the tone should
convey a sense of dissatisfaction, not anger or sarcasm. To word a
Cont’d letter using anger, sarcasm, or slang, may result in immediate
rejection of compensation or the customer simply being ignored.
qOf two types: those with good news and those with bad news.
qA good news letter is when the message of the letter gives the
Cont’d way. The purpose is not to conceal the bad news, but to prepare
the reader to receive the bad news, to break the news gently but
clearly, and to immediately follow up with further explanation
or evidence.
q To break bad news, writers have to set up their reader to receive the
news by providing the relevant factual details that led up to the
decision.
Cont’d
request, as shown in the example below:
Adjustment qIt is important to use clear language to state the bad news; do
Letters – not sugar-coat or dodge the bad news by being evasive.
Cont’d
qWriters should not appear heartless or cold and state the
decision without any sense of feeling or emotion.
q Conclusion paragraphs always end with a wish for goodwill, as
shown in the example below:
Thank you for considering Gardens Gone Wild for your freelance
submission. Please feel free to submit future pieces or rewrite the above
mentioned article and resubmit. We wish you well in your endeavors as a
freelance writer.
Adjustment
Letters – q While the reader did not get what she wanted - publication of her
article in the magazine - the reply is not harsh; it clearly tells the