Technical Report Writing
Technical Report Writing
• Document is the generic term for a written object. Other terms, such
as essay, papers, & work, do not clearly reflect the many types of
technical writing.
• The other purpose of technical writing is also to instruct. Writers give readers directions
for using equipment and for performing duties. Someone must tell consumers how to use
their new purchase, whether it is a TV set or a computer.
•
• Finally, technical writing persuades. Writers present readers with a cogent reason to
follow a particular course of action. On the job, people must persuade others to do certain
things. One writer, for example, persuades readers to purchase Lap top, not Desk top.
• persuade , advocate, convince, urge, influence, defend, recommend, justify, change,
support
• Although any technical writing sometimes has only one of these purposes, it often serves
two or even all the three at the same time.
Audience
• Audiences can be experts, technicians, managers, or general
readers. Each audience will have different needs and expectations.
• Different audiences have different defining characteristics that you
need to identify:
• Education
• Professional experience
• Job responsibilities
• Relationship to your project
• Attitudes toward you and your subject
• Their personal characteristics, such as age, gender, nationality,
culture, values and beliefs
Cont..
• Audience and purpose determine the content, form,
tone and style of every technical document; therefore it
is important to understand them first. You will have
different audiences
• Primary audiences
• Need your information
• Make decisions based on your information
• Secondary audiences
• Have less direct connection to your document
• Examples include sales, marketing, legal audiences
Features of Technical writing
• Technical writing has the following general
features. It engages a
specific audience,
uses plain & objective language,
stresses presentation, and
employs visual aids.
Cont…
Presentational Organizations
• Technical writing is presentational. Presentational
writing employs devices that enable readers to
assimilate information at a glance.
• Good technical writers make the structure of the
document obvious and make the format of the
document easy to scan.
• To make the structure of the document obvious,
technical writers follow the old rule, “Tell them what
you’re going to say; then say it.”
Contd..
• At the beginning of the document, writers often do the following:
• Name the topic and list its subdivisions
• Use obvious repetitions(repeat key words) – to make the
document easy to scan
• Emphasize transitions-to clearly indicate the start of a new
sections
• Chunk information by presenting it short, visual distinct
units
• Use number
• red vertical lists
• Use marginal indentations
Contd..
Visual Aids
• Technical writers use visual aids such as graphs,
tables, and drawings for the following four major
purposes:
• To summarize data
• To give readers an opportunity to explore
• To provide a different entry point to the discussion
• To engage reader expectations-to cause readers to
develop questions about the topic
Characteristics of Technical Writing
• Technical writing has got six specific characteristics Technical
writing which a writer may use as criteria to check the
effectiveness of the report. These are:
• 1. clarity: In technical writing clarity subsumes three things: (a)
choosing the right word; (b) preferring simple words or
combinations to complex ones; and (c) avoiding technical jargon,
except when essential. A method of development and an outline
that puts your thoughts into a logical, meaningful sequence brings
coherence as well as unity to your writing. Who is the audience?
What do you plan to do? When should the job be completed?
• Where will the work take place? Why is the task being undertaken
(rationale, motivation, goal)?
Cont..
• 2. Comprehensiveness: a technical report must be self
explanatory. All the necessary information should be
incorporated to help the audience understand the
purpose.
• 3. Accuracy: information in a technical report must be
exact and up-to-date. In technical writing, errors posit
the company and the employee as bad. What is more is,
errors can lead to damages, injuries, lawsuits, or just
embarrassment and misunderstandings.
• 4. Conciseness: A report must be just to the point;
without extra parts.
Cont..
• 5. Accessibility: It means the ease with which readers can locate
the information they seek.
• To increase accessibility, include headings and lists in the report.
A table of contents, list of illustrations glossary and index are
preferred to maintain accessibility of technical documents.
• 6. Correctness: a report must be free from grammatical errors,
punctuation mistakes, and it should have appropriate standard
format. If a report contains grammatical errors, the reader will
doubt the accuracy of the information in the report. Technical
writing is meant to convey information and to persuade the
audience. To accomplish these goals it must be clear accurate,
easy to access and must be economical and correct.
Unit 2: Steps in Writing Technical Reports
• The writing process
• The goal of the writing process is to generate a clear, effective
document for an audience. Writers can achieve this goal by performing
•
three types of activities.
Prewriting: planning
Writing: drafting
Post writing: finishing
• Planning is discovering and collecting all the relevant information
about the communication situation and deciding what steps to follow
in creating the document.
• Drafting is selecting and arranging all the elements in the document.
• Finally, finishing is editing the document into final form.
Cont…
• Although they may be described differently,
there are five steps in technical report writing.
These are:
Preparation
Research
Organization
Writing
Revision
Cont..
• Preparation: In preparation for writing, your goal is to
accomplish the following four major tasks:
1. establishing your primary purpose: what is the major
purpose for writing a given report?
2. assessing your audience (readers) and the context; Do you
have multiple readers? Who needs to see or to use the
document? What are your readers’ needs in relation to your
subject? What are their attitudes about the subject?
(Skeptical? Supportive? Anxious? Bored?) What do your
readers already know about the subject? Should you define
basic terminology, or will such definitions merely bore, or
even impede, your readers?
Cont..
• 3. Determining the scope of your coverage:
Determining your purpose and assessing your
readers and context will help you decide what
to include and what not to include in your
writing.
• 4. Selecting the appropriate medium. The
most important considerations in selecting the
appropriate medium are the audience and the
purpose of the communication.
Research
• Researching a topic in order to generate a document is an
essential part of a professional life.
• The purpose of research is to find out about a particular
subject that has significance for a given writing purpose.
• Conducting Primary Research
• Primary research has various forms.
• Typical sources of factual information for reports include:
– interviews
– observation
– experimentation
– surveys, questionnaires, and inventories
Cont..
• Conducting Secondary Research
• As with all writing projects, you must plan carefully. In order to do so, you must develop a
search strategy, review reference material, and record your findings.
To follow search guidelines that will help you to find relevant information quickly:
• Consider the date of publication of the information. For instance, if your topic demands
information less than a year old, consult periodicals, government documents, annual reviews,
and full-text data bases.
• If your topic requires established standard information, consult bibliography, annual reviews,
yearbooks, etc….
• Consider the technical level of the information, i.e. if you need information at a high technical
level, etc
• Watch for key documents which you find repeatedly cited in articles, books, or technical
reports.
• Find key terms. Key terms are the specific words or phrases that all writers in a particular field
use to discuss a topic.
Organization
• Organization is the method by which you arrange the information
in your document. You have many options for how you organize
your information. The following are some of the more popular
organizational structures:
• Determining methods of development
• Problem-solution allows you to explain a problem and then provide
potential solutions. This type of organization would be great in a
document presenting ideas of how to improve an area of a
company.
• Chronological organization allows you to write down steps to be
taken based on what should occur first, second, third, and so on. If
you are developing a user manual for a cell phone, chronological
order may be your best organizational option.
Cont..
• Comparison and contrast lets you explain how two items are
similar and then how they are different. This organizational
structure is perfect for explaining how an updated product has
changed from the original.
• Top-down: Finally, a common type of organization structure for
technical documents is the top-down approach. In this
structure, you provide an overview of what you will say at the
beginning of your document, then give the detailed information
in paragraphs and bullet points. The top-down approach would
be great for providing research on a new type of medicine.
• The type of organization you choose for your communication
will vary based on your purpose and audience.
Outlining
• An outline is a plan for or a summary of a writing project or speech.
Outlines are usually in the form of a list divided into headings and
subheadings that distinguish main points from supporting points.
• An outline is a map of a document’s main ideas and supporting
points. It’s not, however, a prose piece a full sentences. It is a full of
concise phrases, organized in the same sequence as the document.
• Memo Format
• Memo format consists of specific lines placed at the top of a page.
• To, From, Subject, and Date lines. Usually such a report is brief—from one or two
sentences to one or two pages.
Cont…
• Memo Format
• Company and/or department name (without address)
Heading
• To (who gets it)
• From (who sent it)
• Subject (what it’s about)
• Date (when it was sent)
Body (conveys message)
• Introduction
• Main points
Close
Cont…
• Memo Style
• Concise: Make your sentences, paragraph, and overall memo as
brief and as focused as possible.
• Clear: Get your purpose straight before you start, then plan
what you want to say and in what order. Use your memo layout
to help your reader (headings, bulleted lists, white space, as
appropriate).
• Direct: Speak directly to your reader, as you would in person or
on the phone. Do not pad your ideas with unnecessary details.
Think of what questions your reader wants answered, and then
answer them.
• Clean: Reread, revise, copyedit, and proofread.
Types of Memos
• Memos are further sub-categorized into positive, negative,
and sales memos depending on their purposes.
1. Positive memo
• Reply to questions about product or service request
• acknowledging an order received
• responding favorably to complaint
•
• use the ABC format for positive memos.
• Abstract bridges the current memo with the previous one.
There must be clear statement of good news that you want
to report.
Cont..
• Body
– Supporting details for the main point.
– Clarification of any question readers may have
– Qualification if any of the good news
• Conclusion
• Statement of eagerness to continue
relationship.
• Clear statement if any of what step should
come next
Cont..
Follow these guidelines to set up a memo.
H. Signature
End your cover letter with your signature,
handwritten, followed by your typed name.
Curriculum vitae
Curriculum vitae is a longer detailed synopsis that
includes a summary of an educational
background, work and research experience,
publication, awards, honors, additional skills etc
A resume is a concise summary of your abilities,
education, and experience.
The difference between the two is that CV is
longer than resume (at least 2-3 pages while
resume is single page).
Elements of CV
Contact information:
Name:
Address:
Telephone:
Cell phone:
Email:
Personal information:
date of birth:
place of birth:
Citizenship:
Visa status:
Gender:
Contd..
Employment history: list of work experience
including position details and dates, academic
positions, research and training (all in
chronological order)
Educational :dates, majors and details of
degrees, training and certifications starting
from the recent
Other skills: language skills, computer skills
and driving skills
Contd…
Interests/hobbies: personal interests and
hobbies related to the vacant post seeking for