Lesson 1: What is Technical Writing?

Technical writing is sometimes defined as simplifying the complex. Inherent in such a

concise and deceptively simple definition is a whole range of skills and characteristics
that address nearly every field of human endeavor at some level. A significant subset
of the broader field of technical communication, technical writing involves
communicating complex information to those who need it to accomplish some task
or goal.
Professionals ranging from doctors and engineers to chemists find it necessary to
convey complex topics to regular consumers or professionals with less experience.
Technical writing describes this process of making complicated information more
accessible in the form of reports, product descriptions or instruction manuals.
Learning more about this communication style can help you pursue a career that suits
your interests and develop the appropriate skills.
Technical writing is one of those in-demand hard skills that will always stay relevant.

From people who need help with their gadgets to engineers who need assistance
with using industrial-scale machines – technical documents help everyone digest
complex information.

Regardless of who the audience is, technical information isn’t always so easy to
comprehend. To that end, subject matter experts work to distill all that information
into easy-to-understand content, which falls under the broad umbrella of technical
writing – a sought-after trait, the meaning of which has become blurry due to its
vast applications.

Technical writing is a form of communication that professionals use to convey

information about specialized topics. A technical writer might create content to
provide instructions or explain technical concepts regarding environmental
regulations, computer applications or medical procedures. Some of the most
common industries that rely on technical writing include:

• Engineering
• Computer software and hardware
• Robotics
• Chemistry
• Finance
• Consumer electronics
• Forestry
• Aeronautics
• Medical and healthcare
• Biotechnology
Summary
• Technical writing is a writing discipline that is sometimes defined as simplifying

the complex.

• Technical writing involves communicating complex information to those who

need it to accomplish some task or goal.

• It often results in relevant, useful and accurate information geared to

specifically targeted audiences in order to enable a set of actions on the part of

the audience in pursuit of a defined goal.

• It is not reserved solely for writing manuals for computers of software. Because

of its wide range, modern technical writing is present in nearly every industry in

some form or another.

An illustrious history
• Technical writing has been recognised as a profession since the 1940s, and
it expanded exponentially with the spread of computers during the second
half of the twentieth century.
• However, its history dates back much further. It could be argued, for
example, that many of Leonardo Da Vinci’s papers are technical writing,
since he was discussing and explaining technology. Some people also cite
Geoffrey Chaucer’s Treatise on an Astrolabe as an early example of a
technical document, and suggest that much of Aristotle’s writing was
technical in its nature.
Examples of technical writing
Here are some prominent examples of technical writing:

• Instruction manuals
• E-learning content
• Product specifications
• Product descriptions
• Reports
• Press releases
• Business proposals
• Job descriptions
• Textbooks

A technical writer may be writing for a specific industry, in which case the
language tailors toward the education level of its audience. However,
sometimes a technical writer is writing for a general audience. Many of the
details provided by technical writers are complex, so the process of writing
involves analyzing the information and presenting it in a way that's easy for
anyone reading it to understand, even someone who does not have a lot of
experience with the topic.

Technical Writing Categories

Technical writing comprises the largest segment of technical

communications. Technical writers work together with editors, graphic

designers and illustrators, document specialists, content managers, instructional

designers, trainers, and analysts to produce an amazing variety of deliverables,

including:

Requirements
Contracts Online and embedded help
specifications
Customer Service scripts Policy documents Simulations

Training course
Demonstrations Process flows
materials

Design documents Project documents User manuals

FAQs (Frequently Asked

Product catalogs Warning labels
Questions)

How-to videos Product packaging Web-based Training

Instructions Proposals Websites

Knowledge base articles Release notes White papers

Reference guides

Technical writing follows a development lifecycle that often parallels the product

development lifecycle of an organization:

1. Identification of needs, audience(s), and scope

2. Planning
3. Research & content development
4. Testing / review and revision
5. Delivery / production
6. Evaluation and feedback
7. Disposition (revision, archiving, or destruction)
References:

https://techwhirl.com/what-is-technical-writing/

https://www.indeed.com/career-advice/career-development/technical-writing

https://technicalwriterhq.com/writing/technical-writing/

https://www.skillsyouneed.com/write/technical-writing.html

Class Activity:
On a one whole sheet of paper, copy and paste a technical manual related to
a profession in relation to your degree course. Include the link on the
description.
Rewrite the manual into a content that will be understood even by 11 years old
and above readers.

Lesson 2: Technical Writing Style

Like any other form of writing, technical writing has its own particular style.

It tends towards:

• Simplicity and conciseness

You may find this hard to believe if you have ever read a computer manual, but
technical writers spend a considerable amount of time and effort keeping
things as simple as possible. They try to keep their writing short, and also use
short words and sentences to make documents easier to read. They also use
the active voice, rather than passive, and avoid the use of jargon.

Technical writing aims for clarity above all.

• Accuracy

The second characteristic of technical writing is its accuracy. There is no room

for ambiguity or errors in a technical document. Users do not want to be making
expensive errors because the documentation was incorrect.

Technical writers therefore need to check everything.

If in doubt, the accuracy of a sentence must be checked with someone with

more knowledge.

• Audience-focused
 Ultimately, every piece of writing should be written with its audience in mind.
However, this is perhaps even more true of technical writing, because you need
to consider your audience’s subject knowledge, which may vary widely. A
document written for experts will be very different from one written for the
general public.

• An objective, fact- and task-based approach

Technical writing is not emotive in style. It uses a very objective, fact-based

approach, because it aims to convey information.

In technical writing that aims to convey instructions, documents will also be

very task-based. They will focus on giving readers the information that they
need to complete the task as easily as possible.

• Careful consideration of design issues

Technical writers often have to do more than simply write. They also have to
consider the design of their document to make it easier to read.

This includes the layout on the page, and the use of headings, subheadings,
bullet points and numbered lists to break up the document. All these facilitate
finding information rapidly, which is crucial in a technical document.

Technical writers also have to consider the use of illustrations such as pictures,
graphs and tables as a way to convey information.

They may therefore be considerably expert in using statistical tools and

software to prepare technical illustrations.

Skills Required by Technical Writers

Technical writers require a wide range of skills. Many of these are similar to other
writers, but there are also some very specific skills needed.

Technical writing skills include:

• Extremely good written communication skills, and especially the ability to

convey complex information in simple language, and to write very clearly.

• An ability to grasp a technical subject quickly. Technical writers are not

experts in everything. However, they usually have the ability to pick up and grasp
technical subjects rapidly. They need to be able to understand enough to explain
the issue simply to others.

• A broad knowledge of technology. Technical writers usually have a broad but

shallow understanding of a wide range of technology issues. This allows them to
 knit their knowledge together effectively with new information, and set their
work in context.

• A recognition of what they don’t know. Technical writers need to be able to

consult with experts or do further research when necessary. They therefore
need to understand the limitations of their own knowledge.

• Knowledge and skill in various computer packages, including statistical

software and design/illustration packages.

• Good proofreading and editing skills. Finally, technical writers need to be able
to read over their own documents and identify typos, spelling mistakes and
grammatical errors. Technical documents need to be free of these errors, and
look professional.

How to become a technical writer

Here’s how to become a technical writer:

1. Pursue education

Most technical writing positions require applicants to hold at least a bachelor’s

degree. Those who want to pursue this field may want to take courses in
technical subjects, including the sciences, engineering and the medical field, in
addition to writing and communication-focused courses. When applying for
jobs, technical writers often need to submit writing samples to show their
proficiency in this style of writing and their knowledge of certain subjects. It is
helpful to maintain a portfolio of samples, especially for those who want to
work as freelance technical writers.

2. Develop relevant skills

Along with earning a degree, you need to build the skills needed to be a
successful technical writer. These include industry knowledge, communication,
writing and other technical experience. Technical writers should have strong
communication and writing skills.

Good computer skills can allow you to use several different software programs
to create and change diagrams, illustrations and documents. A technical writer
also has strong proofreading and editing skills so they can deliver documents
free of style-related and grammatical errors. Additionally, technical writers use
tables, diagrams, charts, photographs, illustrations and drawings more clearly
and effectively.
3. Learn style guides

It is also helpful to become proficient in all the major style guides, including the
MLA Handbook, The Chicago Manual of Style, The Associated Press Stylebook,
APA Style, and the Institute of Electrical and Electronics Engineers (IEEE) style.
IEEE is the most commonly used style in technical documents, especially in the
engineering industry, although different companies and clients have their own
requirements. If you work in a specialized industry, consider focusing solely on
that style guide and the company’s unique requirements.

4. Become certified

Technical writers can also go through a process to become certified. The three
main certification options are:

Society for Technical Communicators

The Society for Technical Communicators offers a three-tiered program for

certification. The tiers are Foundation, Practitioner and Expert. Each level
requires you to pass a more rigorous and difficult exam than the previous level.
When you hold a certification from this society, you may have an advantage
over other technical writers who have not completed the certification process.

American Medical Writers Association

When pursuing a career as a technical writer in the medical field, you’ll

probably need to learn to write about specialized tools and processes only
found in healthcare. Therefore, the medical writer certification through
the American Medical Writers Association is a good option if you plan to choose
this career path. You must have at least two years of experience in medical
communications and a bachelor’s degree to become certified. After receiving
your certification, you must take continuing education courses throughout your
career to maintain its validity.

National Association of Science Writers

The demand for technical writers is especially high in the sciences. Becoming
certified through the National Association of Science Writers can help you show
that you have knowledge of scientific topics and strong writing skills. When
applying for this certification, you must provide five pieces written within five
years and two recommendations from current members of the association.
5. Determine where you want to work

A technical writer might work on a freelance or contract basis, or they can often
find full-time positions with software or hardware companies, engineering
firms, construction firms, chemical processing companies, defense companies
and other related businesses. Understanding the field and what it requires is an
important first step to making sure it is what you want to pursue in your career.
Talk to technical writers to get an idea of what their daily job duties include or
review technical documents, including customer support content and
professional guides.

6. Develop a portfolio

When you apply for a technical writing job, it’s important to show proof of your
skills. If you’re an entry-level writer, you can work on technical documents on
your own to create a portfolio. While earning your bachelor’s degree, you can
also look for internships and freelance writing opportunities to gain more
experience.

7. Build your network

Start by looking in your existing network of professional contacts to determine

if you know anyone in technical writing. Connecting with other people can help
you find job opportunities and become part of groups that focus on the field of
technical writing. You may also want to attend related conferences and events
in your area to further build your network of contacts.

Reference:

https://www.skillsyouneed.com/write/technical-writing.html

https://www.indeed.com/career-advice/career-development/technical-writing

Class Activity:
Copy a technical manual/health advocacy campaign and paste it on
a paper. On the same paper, translate the manual or health advocacy
campaign into an easy-to-understand Waray Waray language.