Technical Writing
Lecture 3
Unit One: What is Technical Writing?
• Definition & Importance of Technical Writing
• Characteristics and Constraints
• Good technical writing style
• Skills Needed for Technical Writing
Unit One: What is Technical Writing?
• Skills Needed for Technical Writing
• To be a successful technical writer, there is a core
set of skills that you will want to master. Here are
some of the most common skills needed to be
successful:
Unit One: What is Technical Writing?
• Research
Research is one of the first steps in technical writing. After you
have an assignment, you will be responsible for collecting the
data (numerical and non-numerical) and turning it into valuable
information.
Research can come from a variety of places including:
On-Site Data
Online and Intranet Publications
Interviews
Libraries and Research Databases
Unit One: What is Technical Writing?
• Audience Perception
The technical information you research and gather has to be
shaped for reader interest, understanding, and perception.
Technical writers often have to communicate highly technical
information to a non-technical audience. Therefore, an early
step in the most effective technical writing process is analyzing
your audience carefully so you can match information to their
needs.
Unit One: What is Technical Writing?
• Communication Skills
Communication skills are imperative to be a successful technical
writer. You will likely be working with multiple teams and
individuals from differing roles. Your ability to listen, record, and
communicate will be crucial.
Unit One: What is Technical Writing?
• Technical Skills
It is imperative that you understand the technical nature of the
content you are writing about. It is difficult to clearly convey a
concept that you have not mastered.
Technical writing is slightly easier if you come from the technical
side and are learning to write. It is sometimes more difficult if
your background is in writing and you are trying to learn the
technical content.
Unit One: What is Technical Writing?
• Writing
Excellent writing skills ensure your documents are easy to read
and are free of errors. Writing encompasses many of the other
skills on this list. It is important that you have the correct tone,
style, and format for your document.
Often these rules are outlined by the employing organization in
a style guide.
Unit One: What is Technical Writing?
• Document Design
• You may be responsible for adding graphics to complement
your document.
• It is important that the graphics aid the reader in
comprehending the information. Graphs, tables, and charts
are commonplace in technical reports.
• You will also need to be proficient in formatting documents.
The formatting should be professional and aid the reader in
navigating the document. Headings should be easy to skim,
and the content should be organized logically.
• A poorly designed document will make it more difficult for the
reader to understand the content. Document design is a key
aspect of technical writing.
Unit One: What is Technical Writing?
• Fluency with Digital Tools
• Today writers must use multiple tools during the technical
writing process. This often goes beyond basic text editors.
Technical writers are expected to be able to create graphics
and annotate images and screen captures and extract data
from Excel and convey that data in charts and tables.
• Additionally, they can utilize planning, writing, and editing
tools used by business writers.
Unit One: What is Technical Writing?
• User Research and Testing
• Some forms of technical writing may require user research
and testing. An example application where detailed research
and testing would be appropriate is a written guide instructing
engineers how to fix a faulty mechanism on a deep ocean oil
rig.
• It is important that the documentation is easy to follow,
especially if the application is crucial to a major function. To
accurately write the guide, the writer may first observe how
engineers solve the problem. They may use recording devices
or just notes to write down the research. This type of research
is closely related to testing.
Unit One: What is Technical Writing?
• Testing is necessary to ensure your document functions as
intended.
• After the writer has completed a draft of the document, they
may give it to a test group to read. They can then observe the
end users following the instructions in real time.
• They may follow-up with a focus group or survey to get
feedback on the usefulness of the document. They will use
these real-world insights as they revise the document.
Unit One: What is Technical Writing?
• Industries That Use Technical Writing
• Today technology has expanded into every facet of business.
Companies continue to develop ever more technical processes
in search of higher efficiency and profit.
Below is a list of industries where strong technical writing is
required.
• Biotech & Pharmacy Consulting
• Energy and Chemical Engineering
• Information Technology Financial Services
• Government & Nonprofit Insurance
• Manufacturing Supply Chain
Unit One: What is Technical Writing?
• How to Improve Your Technical Writing Skills
• You don’t need to have the title of “technical writer” to utilize
technical writing skills in the workplace. If you work for a
company that deals in highly skilled or technical or analytical
work, you likely already conduct technical writing.
Unit One: What is Technical Writing?
• Read
• One of the best ways to become a better writer is to read.
Reading helps you train your brain to understand how to
write. The more you read, the easier writing will become for
you.
• It is critical that you are reading relevant and high-quality
documents. Look for documents produced by competitors or
writers in related industries. Examine their writing to
determine how they organize information through written
text.
Unit One: What is Technical Writing?
• Create a Process
• Having a process keeps you from “getting stuck” while writing.
Having a clear workflow will help you systematically
accomplish your work.
Unit One: What is Technical Writing?
• Seek Feedback
• Getting subjective and objective feedback on your writing is
one of the fastest ways to improve your skills.
• To improve your writing, you need someone to review not
only the grammar and syntax but also your approach and
methods as a writer.
• To truly master technical writing you need to get feedback
from a mentor. This may be someone in your organization or
through a professional development group. Another great
option if you are taking an online course is working with your
instructor to improve your writing techniques.
Unit One: What is Technical Writing?
• Practice
• Repetition is the key to cementing your new skills. Look to
incorporate new concepts into your work. You can even
review old work to critique what you would do differently if
you were to write the document today.
• Verify that the course you take includes practice opportunity.
For example, does the course require you map the
organization and sequence of a technical document? Since
this is a core technical writing skill, you want to make sure you
get professional feedback on your ability to do this.
Thank You For Listening
