This document provides guidance on technical writing. It discusses planning the writing process, focusing on clarity, correctness, conciseness, control and coherence. It also addresses using plain language and avoiding gendered terms. Additional sections cover formatting techniques like substituting wording and parts of speech. The document instructs on using first, second and third person point of view. It lists the typical sections of a technical report and concludes with tips on knowing the audience and maintaining an impersonal, straightforward style with sufficient detail.
3. Identify your audience and their expectations
Know your purpose Know your material
Understand the writing task at hand
Organize your thoughts and materials
Budget adequate time to write, review, revise and edit
2
5. mankind → humanity
best man for the job → best person for the job
the common man → average person, ordinary people
mailman → mail carrier
congressman → congressional representative
policeman → police officer
4
6. Category Example Subtitle
Nouns Utilization
Functionality
Use
feature
Verbs Facilitate
Finalize
Cause
end
Adjectives Aforementioned
Individualized
Mentioned
individual
Adverbs Firstly,
Secondly
First
second
5
7. (already) existing never (before)
at(the) present (time) none(at all)
(basic) fundamentals now(at this time)
(completely) eliminate period(of time)
currently(being) (separate) entities
(currently) underway start(out)
introduced (a new)
mix(together)
6
8. Substitutions of Common Phrases, Plainer
Synonyms.
a number of → few, many, several, some
a majority of → most
accordingly → therefore
actually → (consider eliminating this word)
additional → more, added, other
adequate number of → enough
7
9. Describing events as a participant, such as “I raced to catch the train
before it could enter the tunnel” (told in the first person because it
uses “I”)
Giving instructions to someone directly, such as “You must catch the
train before it reaches the tunnel” (“you” is used for second person)
Relating events about others, such as “He failed to catch the train
before it reached the tunnel” (third person because of “he”)
First person uses: I, we
Second person uses: you
Third person uses: he, she, it, one, they
8
10. Title + Certificate + Acknowledgement
Abstract + Keywords + Contents
Introduction
Literature survey
Problem formulation + Hypothesis
Design of Experiments
Results and Discussion
Conclusion and Future scope
References
Appendices
9
11. Know your audience.
Use an impersonal style.
The writing should be straightforward.
Gather information from a number of sources.
Be thorough in description and provide enough
detail to make your points.
10
Like because, we use as and since to give reason but with as and since, the reason should already be known by the listener.
As we lost the final game, we couldn’t qualify for the semi-final.
Use genderneut ral l anguage.
Ot her ways t o handl e t hi s probl em are t o recast a sent ence i n t he pl ural , reword t o el imi nat e gender
probl ems, or repl ace t he mascul i ne pronoun wi t h “one” or “you”.
An expert in the field can only understand certain abbreviations, acronyms, and lingo that directly applies to such a field.
Write from a third person perspective, like a teacher instructing a student. Any opinions should be omitted.
3. to the point, and as simple as possible to make sure the reader understands the process or instruction.
understand the information gathered so that it can be analyzed thoroughly, and then put the information into an easy to understand format to instruct those who read it.