Introduction To The Course - ST
Introduction To The Course - ST
Introduction To The Course - ST
References
1. Steven M. Gerson. Writing That Works: A Teacher’s Guide to Technical
Writing, Kansas Curriculum Center Washburn University Topeka, KS.
5
1.1.1. Introduction to technical writing
* Some
examples
https://vnexplorer.net/covi
d-19-prevention-and-
control-five-rules-to-
follow-a202018169.html
2/29/2024 6
Technical Writers Work in
TWP necessity
• No matter how brilliant or innovative an
idea may be, if it is not communicated
clearly and promoted effectively to the
right audience, it will not become a reality.
• Ex.: For an innovative idea to move
from concept to project to completion
requires many stages in a design
process, almost all of which require
clear communication and effective
teamwork.
• TWP introduces the key elements of
professional style, document design,
collaboration, oral presentation, and
research skills needed to design productive
workplace documents and presentations for
a variety of purposes and audiences.
• The ability to communicate clearly and
effectively in written, verbal, visual, and
interpersonal contexts is vital for success
and advancement in the workplace.
What is Technical Writing?
• Technical writing is an audience-centered means of
communication that provides a reader with clear and easy access to
information.
• The writer recognizes, respects, and addresses the importance of time
in effective and efficient communication by providing documents
written in specific formats, using unambiguous language to send
clearly assessable information.
• The reader in turn thoroughly understands the information in order to
give a thoughtful response.
Technical Writing: A Definition
2/29/2024 11
Why is technical writing so important?
Employers want to hire people who can communicate effectively, both in writing
and orally. Career counselors reiterate this.
▪ an employee will spend at least 20 percent of his or her time writing.
▪ This number increases as an employee’s responsibilities increase.
▪ Managers spend up to 50 percent of their time writing.
▪ CEOs spend between 80 and 100 percent of their work week communicating.
Examples
• Technical writing, which must be understood easily and quickly,
includes:
– memos and e-mail
– letters
– reports
– instructions
– brochures and newsletters
– the job search
– web pages
– fliers
– PowerPoint presentations
– Graphics
In each case, the technical document must be quantifiable, precise, and
easily understood.
Formatting and Language
2/29/2024 16
1.2. Types of technical writing
iii) Patents
2/29/2024 17
When our students are employed and have to write on the job,
will they write essays?
The answer is no. The students, when employed, will not write essays at
work. They will write essays while working on their college degrees;
they might even be asked to write an essay on their job application when
applying for work. However, once the job begins, essays end.
Absolutely not. Many of the writing skills you already teach are applicable to
technical writing. Others are less valid.
Comparison/Contrast: Technical Writing
vs. Essays
Academic Writing versus Technical Writing
Academic Writing Technical Writing
Text
Text
• Article • Needed
• Book
• Assignment ➢ Read for Information
Format
Academic Writing Technical Writing The definite purpose,
strict format, and use
of appropriate
Paragraphs Major Headings language in technical
• Topic Sentences Sub Headers writing define the
Markers differences between
technical writing and
Pictures • Bullets academic writing.
• Underlings
• Bold type
White Space.
Illustrations
• Graphs
• Tables
• Pictures
• Drawings
Language
Academic Writing Technical Writing • The definite purpose,
strict format, and use of
appropriate language in
Words Words technical writing define
• Elaborate • Active vocabulary the differences between
• Transitions ➢ Plain technical writing and
• Subjective ➢ Easily understood academic writing.
• Cogitative Elaborate • Objective
• Non-sexist
• Multiple meaning • Avoid pronouns
The engineering
design process
Writing Processes
A process defines Who is doing What, When, and How, in order to reach a
certain goal.
40-20-40 Writing Process
• Stage 1 – Planning: spend 40% of your time planning your document
(task analysis, thinking, discussing, free-writing, researching,
brainstorming, concept mapping, focusing ideas, outlining, etc.)
34