Technical Documents

• These are documents which provide technical

information

• These documents are used in organizations

Technical Documents
“ Producing technical communication involves
creating, designing and transmitting technical
information so that people can understand it
easily and use it safely, effectively and
efficiently.”

(Markel, 2001)
Technical Documents
Examples
• Textbooks
• Phonebooks
• Procedural manuals
• Corporate plan
• Report
• Proposal
• Annual reports
Technical Document
• Producers

Technical Professionals : engineers, business

people, corporate planners, attorneys,
company secretaries, etc

Technical communicators: They create

documents, including manuals, proposals,
report, sales literature.
Role of Technical Comm.
• Memo or email requesting a meeting

• Travel Report

• Annual report highlighting, among

other things, the profit/loss of a
company.
Role of Technical Comm.
• Instructions introducing or explaining a
new process

• A proposal for a new campaign

• Oral presentation to the board of

directors for a company
Career requiring writing skills
“From an organization that manufactures medical
instruments
Design Assurance Engineer: Duties include
performing electronic/mechanical product,
component, and material qualifications. Requires
spread sheet/word processing abilities, and
excellent written/oral communication skills. BSEE or
biology degree preferred.”

(Markel, 2001)
Career requiring writing skills
“From a corporation that manufactures custom-
molded plastic components

Custom injector molder needs a process engineer.

Manufacturing knowledge and experience with
statistical process control required. Experience with
injection molding and ASQC certification a plus.
Excellent writing and speaking skills required as well
as word-processing and spread sheet skills.”

(Markey, 2001)
Effective Writing
• Audience – Who is your target group?
Who will read your work?

• Purpose – Why are you writing this

technical document?
Effective Writing
• Message- What do I have to say to the
target audience?

• Style & Tone – how will I give the message

to the target group?
Characteristics
Technical Writing

• Addresses readers
• Helps readers to resolve problems
• Reflects an organization’s goals and
culture

• (Markel, 2001)
Characteristics
Technical Writing

• It is produced collaboratively
• It uses design to increase readability
• Uses words and graphics
• Uses High tech tools

• (Markel, 2001)
Measures of Excellence in Technical Writing

1. Honesty
2. Clarity
3. Accuracy
4. Comprehensiveness
Measures of Excellence in Technical Writing

5. Accessibility
6. Conciseness
7. Professional Appearance
8. Correctness
How to write a Technical
Document…
Writing Technical Documents
• Provide practical information
• Give Facts
• Provide Visuals
Writing Technical Documents
• Give accurate measurement
• State expectations clearly
• Persuade or offer recommendations
• Adhere to Ethics
Memorandum
TO:
FROM:
SUBJECT:
DATE

(BODY)
In- class Activity
- Look at the different technical documents and comment on
the following:
- Writing style
- Language use
- Visuals
- Audience
- Message
- Is the tone appropriate for the audience?