Professional Documents
Culture Documents
CH 1 Tech
CH 1 Tech
INTRODUCTION TO
TECHNICAL COMMUNICATION
MINU JOBBY
B U S I N E S S C O M M U N I C AT I O N S U N I T , C E P S , S Q U
BCOM4931_MJ 1
Learning Objectives
What is Technical Communication?
What are your roles as a communicator?
How important is Technical Communication to your
career?
What are the characteristics of a Technical Document?
Identify the measures of excellence in Technical
Communication
BCOM4931_MJ 2
1. What is Technical Communication?
BCOM4931_MJ 3
Examples: Where do you see Technical
communication?
BCOM4931_MJ 4
1. What is Technical Communication?
Definition: Technical
communication is the process of
finding and using information
and sharing meaning.
BCOM4931_MJ 5
Technical communication & other types
of writing – the difference
ACADEMIC WRITING TECHNICAL WRITING
Descriptive Writing Résumé, Explanation Process, Job Description
Persuasive Writing Proposal, Job Application Letter, Action plan
BCOM4931_MJ 6
Examples of Academic Writing &
Technical Writing
Academic Writing Technical/Professional Writing
Project Report Technical manuals
Examination Answers Industrial reports
Lab reports Project Proposals
Dissertations Business Letters
Abstracts E-mails
Scientific articles Memos
Lecture notes Meeting Agenda
Research papers Meeting minutes
BCOM4931_MJ 7
Focus of Technical Writing
1. PROCESS
• Finding information & developing ideas
2. APPLICATIONS
• Reports, memos, proposals etc.
3. TECHNIQUES
• Analyze audience & purpose
• Research information on the subject
• Arrange information skillfully to meet audience needs and preferences
• Deliver information using the most effective applications
BCOM4931_MJ 8
2. What are your roles as a
communicator?
Role
Technical Technical
Professional communicator
Information
Writer of the Member of a
resource (internal
document project team
or external)
BCOM4931_MJ 9
3. How important is Technical
Communication to your Career?
• Writing and speaking are the first outward
sign of your abilities: Managers will notice
BCOM4931_MJ 10
Technical Communication and Career
֍ As an employee or intern in the nonprofit sector (an environmental group or a government agency), you will research
important topics and write brochures, press releases, or handbooks for clients.
֍ As a medical professional, psychologist, social worker, or accountant, you will write & keep precise records that are
increasingly a basis for legal action.
֍ As a scientist, you will report on your research and explain its significance.
֍ As a manager, you will write memos, personnel evaluations, and inspection reports; you will also give oral presentations.
֍ As a lab or service technician, you will keep daily activity records and help train coworkers in installing, using, or
servicing equipment.
֍ As an attorney, you will research and interpret the law for clients.
֍ As an engineer or architect, you will collaborate with colleagues as well as experts in related fields before presenting a
proposal to your client. (For example, an architect’s plans are reviewed by a structural engineer who certifies that the
design is sound.)
֍ As an employee of any company or organization, you will write status reports, trip reports, memos, proposals,
instructions, and many other forms of technical communication.
BCOM4931_MJ 11
4. What are the characteristics of a
Technical Document?
AUDIENCE DRIVEN
HELPS READERS SOLVE PROBLEMS
PRODUCED COLLABORATIVELY
BCOM4931_MJ 12
1. Writing is always Audience driven
Develop a Reader Profile
Who are
they?
How will
they be
What do
they need?
The answers to the questions
reading
help you decide what kind of
Profile documents to write, how to
of
Readers structure it, how much detail
When will Where will to include, the sentence style
they be they be
reading reading? and vocabulary to use
Why will
they be
reading?
BCOM4931_MJ 13
4. What are the characteristics of a
Technical Document?
AUDIENCE DRIVEN
HELPS READERS SOLVE PROBLEMS
PRODUCED COLLABORATIVELY
BCOM4931_MJ 14
2. Writing must help to solve reader’s problems
BCOM4931_MJ 15
3. Reflects on organization’s goals and cultures
16
BCOM4931_MJ
3. Reflects on organization’s goals and cultures (Eg.)
BCOM4931_MJ 17
3. Reflects on organization’s goals and cultures (Eg.)
BCOM4931_MJ 18
3. Reflects on organization’s goals and cultures (Eg.)
19
BCOM4931_MJ
Example: Reflects on organization’s goals and
cultures
BCOM4931_MJ 20
4. Technical Document is produced
collaboratively
Nobody has all the information, skills or time to create
large documents.
For larger and advanced documents, there is a need for
writers, editors, designers, designers, translators, production
specialists to work with technical professionals or content
experts.
Social Media(blogs, Twitter, Wikis) has made collaboration
more convenient.
BCOM4931_MJ 21
5. Technical Documents uses design to
increase readability
Design aspects in technical documents Typography
makes the document look attractive
Spacing
& professional
Headers & Footers
Design aspects in technical documents
Color
helps readers navigate the document
Design aspects in technical documents Justification
BCOM4931_MJ 22
Font type: Serif & Sans-serif font
BCOM4931_MJ 23
6. TECHNICAL
COMMUNICATION
COMBINES
WORDS OR
IMAGES (GRAPHICS) OR BOTH
BCOM4931_MJ 24
GRAPHICS
• ILLUSTRATIONS
• PHOTOS/IMAGES
• FIGURES
FUNCTIONS OF IMAGES
(STATIC/MOVING)
Make documents interesting and reader-
appealing
Communicate and reinforce difficult concepts
PRODUCED COLLABORATIVELY
BCOM4931_MJ 26
5. Measures of Excellence in Technical
Communication
Honesty
Clarity
Accuracy
Comprehensiveness
Accessibility
Conciseness
Professional Appearance
Correctness
BCOM4931_MJ 27
1. HONESTY
Tell/Write the truth. Incorrect information can lead to accidents and misleading
information/claims can lead to lawsuits.
Examples of Dishonesty:
Misrepresenting facts in order to make one’s organization look better is dishonest.
Leaving out negative parts of customer reviews if you're using quotes on a webpage, for
example, is unethical.
BCOM4931_MJ 28
2. CLARITY
Document must convey single meaning to the
reader to ensure that the reader can understand
clearly
BCOM4931_MJ 29
3. ACCUARACY
Technical documents must be factual, objective and
unbiased.
Accuracy means to get your facts straight: but do not provide
unwanted specifics.
Include only those details that are necessary for the readers’ to
achieve their purpose
Accuracy is also allied with conciseness or Brevity.
Striking a balance with enough and too much information is
important to analyse.
BCOM4931_MJ 30
4. COMPREHENSIVENESS
Document should include all necessary
information that readers need.
Background information, details and supporting
information (attachments) is necessary
Comprehensiveness is important as the readers need
a complete and self contained discussion to use the
information safely, effectively and efficiently.
BCOM4931_MJ 31
5. ACCESSIBILITY
Technical documents (most of
them) are made of small,
independent sections. Your job is
to make its various parts
accessible (locate easily)
BCOM4931_MJ 32
6. CONCISENESS
Eliminate unnecessary
phrases
Choose smarter words Is it really
Use economical necessary?
grammatical forms
BCOM4931_MJ 33
An example of Conciseness
Blasting is a very important and significant process, which can be defined as a process where rock is broken
into fragments for a remarkable purpose, that is, recovery of valuable ore. It cannot be denied that modern
technology has led to the advent of modern earth moving and rock-breaking equipment, but the advent of such
sophisticated equipment has not diminished the value of explosives, which still remain the cheapest method of
rock-breaking. However, there is no doubt that rock breakage by explosives has a negative impact on the
environment, resulting in certain negative environmental consequences. These negative environmental
consequences include ground vibration, air-overpressure, noise, dust, and toxic fumes.
(Number of words:111)
Blasting is a process where rock is broken into fragments for recovery of valuable ore. Despite the advent of modern
earthmoving and rock breaking equipment, explosives still remain the cheapest method of rock breaking. However,
rock breakage by explosives has environmental consequences, which include ground vibration, air-overpressure, noise,
dust, and toxic fumes.
(Number of words: 54)
BCOM4931_MJ 34
An example of Conciseness
BCOM4931_MJ 35
Checklist for Conciseness
Avoid repetition
Avoid using wordy phrases and expressions
Do not include unnecessary details
Revise your document thoroughly in order to make it
concise
Avoid exaggeration
BCOM4931_MJ 36
Example
Communicating Concisely
Due to the fact… because
Mr. Saeed is a wonderful person who Mr. Saeed had excellent sales record in
made excellent sales in Quarter 3 of last the third Quarter of 2022.
year.
In my opinion, the CEO’s wonderfully The CEO’s presentation convinced the
made presentation remarkably convinced stockholders.
the stockholders in his favor.
BCOM4931_MJ 37
7. PROFESSIONAL APPEARANCE
If the documents looks neat and professional,
reader will form a positive impression of the
document and yourself.
Your document should adhere to the format
standards of your organization and professional
field.
BCOM4931_MJ 38
8. CORRECTNESS
A correct document is one that follows the
proper rules of grammar, punctuation,
spellings, word usage etc.
BCOM4931_MJ 39
CORRECTNESS
BCOM4931_MJ 40
5. Measures of Excellence in Technical
Communication
Honesty
Clarity
Accuracy
Comprehensiveness
Accessibility
Conciseness
Professional Appearance
Correctness
BCOM4931_MJ 41
END OF CHAPTER
BCOM4931_MJ 42