Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 3

REPUBLIC OF THE PHILIPPINES

Southern City Colleges


DEPARTMENT OF EDUCATION AND LIBERAL ARTS
Pilar Street, Zamboanga City
www.scci.edu.ph

Prepared by:
DEO J. GALVEZ, LPT
Course facilitator

Module 1: Principles of Technical Writing


UNIT 1
Intended Learning Outcomes
At the end of studying this module, students will be able to:

Identify the nature of technical writing and qualities of an effective


technical writer;
Differentiate technical from non-technical writing; and
Analyze the components of technical writing and the stages of writing
process.

Defining technical writing

 Traditional Definition of Technical Writing


o Technical writing is the practice of documenting processes, such as software
manuals or instructional materials. Traditionally, it was limited to user manuals of
some sort.
 New Definition of Technical Writing
o Today technical writing encompasses all documentation of complex technical
processes. It includes reports, executive summary statements, and briefs. Any
time technical information is conveyed in writing at work, it is, by definition,
technical writing.
o This can include high-tech manufacturing, engineering, biotech, energy,
aerospace, finance, IT, and global supply chain.
o The format is no longer bound to lengthy user manuals. Technical information
must be distilled and presented unambiguously. This can come in the form of
technical reports, emails, policy, briefs, and press releases.
 Technical Writer
o A technical writer is a professional writer that communications complex
information. So what exactly does a technical writer do? They create technical
documentation that includes things like instruction manuals, user manuals, journal
articles, quick reference guides, and white papers. They may also create more
common types of content including social media posts, press releases, and web
pages.
o Essentially, technical writers break down complex technical products into easy-to-
understand guides that help the end-user understand how to use the products and
services. They are subject matter experts that often have an educational
background in technical fields including engineering, computer science,
information technology, and information development.

 General Process for Technical Writer


Over the years, technical writing has experienced a dramatic shift. Today, technical
writing involves producing technical information as part of a larger content management
plan. Technical writers work closely with team members including graphic designers,
content writers, document specialists, and industry experts to create technical documents.
They may also work with fellow writers to develop their business writing skills
depending on the project and document type.
For most projects, technical writers use the following steps:
1. Conduct audience analysis and identify any special needs
2. Plan and outline the scope of the project including roping in additional team members as
needed.
3. Topic research, obtaining product samples, document design, and technical content
writing
4. Testing and review of the technical communication
5. Delivery and second revision if necessary
6. Decide on whether the document should be archived, revised, or destroyed.

You might also like