·Five Traits of

Technical Writing
 Clarity
Clarity is the quality of being clear, transparent, or
easily understood. It refers to the absence of confusion
in communication, making information or ideas readily
comprehensible.
 Clarity in Writing
In writing, clarity refers to how easy it is to understand something. There are a
number of factors that determine how easy or difficult it is to read a piece of
writing. As a general rule, clear writing is characterized by:

• Clear word choice.

• Short, briefly and clearly expressed sentences and paragraphs.
• A direct thesis, topic, or main idea. Attention to a specific audience.
 How to avoid confusing sentences
and write with clarity
1. Choose the right words
Usually, the "right" words aren't the longest or most elaborate. They're the ones your audience will
understand the easiest and that best convey your meaning. This doesn't require you to use a smaller
vocabulary or write at a more basic level than you would choose. You simply need to use the most precise
language possible, even if it calls for choosing a shorter or simpler word.

2. Avoid jargon
Technical terminology and abbreviations that consumers might not comprehend are common in
many professions and academic fields. It's acceptable if you're sending a light email to coworkers who are
conversant in the language. However, avoid employing complex technical terms or jargon in the majority
of other situations. To avoid confusion, if you must use it, clarify it inside the text or include a footnote.

3.Use short sentences

Meaning gets lost when a sentence is too long, wordy, or complex. Instead, use short, simple
sentences that are easier to read and understand.
Examples:
Original: As a senior administrator, I made multifarious and abounding contributions to improve
daily processes.
Correction: As a senior administrator, I made numerous contributions to improve daily processes.
Jargons
Original: The success of your social media ad campaign depends on the CPC. Correction: The
success of your social media ad campaign depends on the cost per click (CPC), a metric that
shows the total cost to advertisers based on the number of clicks received.
Use short sentences
Original: Although there are many ways to cook a grilled cheese sandwich, you should start by
buttering two slices of bread with butter, but you can use mayonnaise if you prefer it.
Correction: There are many ways to cook a grilled cheese sandwich. First, butter two slices of
bread. If preferred, mayonnaise can be used instead.
 Conciseness
Conciseness is the quality of being short and clear,
and expressing what needs to be said without
unnecessary words
 How to achieve a
CONCISE technical writing?
Avoid Redundancy
01 Redundancy occurs when a writer unnecessarily repeats
something.

EXAMPLE:
We collaborated together on the project.
 Avoid Prepositional Phrases
02 Try to avoid using too many prepositional phrases in a single
sentence, since they can obscure the main subject and action
of a sentence.

EXAMPLE:

WORDY SENTENCE LESS WORDY SENTENCE

I will see you in the near

I will see you soon
future
 Avoid Passive Voice
03 Using the passive voice distances the subject from the action of
the sentence, which leads to less clarity and urgency.

EXAMPLE:

??? ???

It is my decision to run for my office I decided to run for office

 Avoid Passive Voice
03 Using the passive voice distances the subject from the action of
the sentence, which leads to less clarity and urgency.

EXAMPLE:

PASSIVE VOICE ACTIVE VOICE

It is my decision to run for my office I decided to run for office

 Accessibility
Accessibility can imply different things to different people,
it is primarily driven by a desire to give users—and
particularly users with disabilities—comfortable use. In
spite of any handicap, an accessible design makes it
possible for any member of your target market to utilise
your product with ease.
 Accessibility in
Technical Writing
This accessibility is what you can see in your work. The
page lay out or the way text looks on the page.
The primary goal of technical writing is to effectively
convey instructions on how to use a product. The user will
benefit from this accessibility since it makes text easy to
read and offers sufficient clarity.r main idea. Attention to a
specific audience.
How To Create Accessible
Technical Documentation?
01 Clear And Simple Language For Everyone

02 Headings And Subheadings To Organize Content

03 Non-text Content With Alternative Text Descriptions

04 Different Forms Of Content For Particular Individuals

05 Hyperlinks, Navigational Aids, And Semantic HTML Tags

The text of this paragraph can be
improved by using the highlighted
techniques listed below:
varied font types, varied font sizes
numbered lists
bullets
boldface text, italics
underlining
white space
headings and subheadings
graphics (table and figures)
These highlighting strategies can give your content a bright,
welcoming feel. A revised copy of the information given in the
sample paragraph is shown below.
 THE IMPORTANCE OF
ACCESSIBILITY IN TECHNICAL
WRITING
It's crucial to consider accessibility while creating technical
documentation. When attempting to use a new product or service,
people with unique talents frequently start with user manuals, software
instructions, and other technical resources. A dissatisfied and unhappy
client base will result if certain segments of your target audience are
unable to read the material on your website because you failed to take
into account their issues. Additionally, it may cause a sense of exclusion.
Audience Recognition
AUDIENCE
Any note, letter or report you write will be read by
someone. And we can call them as the "Audience"
In technical writing, the writer and the reader both are
merge.
When a technical writing is submitted, the reader
responds.
Some QUESTIONS for
Audience Recognition
Who is your reader?
What is his/her level of understanding?
What does her role entail in terms of your job title?
Develop a profile of your audience
High Tech Audience - They share their educational background and knowledge with you.

Low Tech Audience - Low tech audience are those readers who are familiar about the
technology you write about but not how they function.

Lay Audience - Readers who are not familiar with your subject matter, so you should write
simply.

Multiple Audience - They are the mix audience, with high tech, low tech ,or lay audience
and they have diverse understanding.
 Accuracy
Successful technical writing must be accurate,
whether grammatically, electronically, etc. You can
apply the following proofreading techniques to
ascertain the accuracy of your technical documents.
 Use your computer’s spell check—remember, however,
01 that a spell check will not catch from if you mean form,
too if you mean to, or accept if you mean except.

Let it sit—for days or weeks. When your document is icy,

02 you are more objective about your own writing,

Use peer evaluations—others will see the errors you

03 miss.

04 Read it aloud—sometimes, you can hear errors.

ead it backward—then you read words out of context.

05 You cannot anticipate the next word.
Thank
you!