Professional Documents
Culture Documents
5. Report Writting and Documentation- PPT
5. Report Writting and Documentation- PPT
1
Report Writing
• The writing process consists of five primary
stages:
1. Planning to write
2. Organizing your information
3. Determine an appropriate medium
4. Writing the draft
5. Revising
2
Writing process
• Gather →Organize→ Focus→ Draft→ Edit
Gather
• Articles, Books, Financial Statement,
Interviews, Databases, Information from world
wide Web, Brain Storming, personal Notes,
and others.
Organize
• Strategic order, batching or grouping ideas,
Heading, introduction, Body and conclusion.
3
Writing process (cont.)
Focus
• “Skim only technique”, ”Nutshell”, “teach” your
ideas, elevator techniques, and others.
Draft
• Organize and focus first, Compose in any order,
avoid editing, get a typed copy and leave a time
gap before editing.
Edit
• Edit for strategy, for macro issues, for micro
issues and edit for correctness.
4
Characteristics of a Good Report
Precision
The accuracy of facts
Relevance
Conciseness
Render-orientation
Simple language
Grammatical accuracy
Unbiased recommendation
Clarity
Attractive
5
The 7C’s for Report writing
6
The 7C’s for report writing … cont’d
7
4S’s for report writing
8
Importance of Reports
• Some of the reasons we write reports are to:
1. Inform
2. Make proposals or recommendations for
change
3. Analyze and solve problems
4. Present the findings of an investigation or
project
5. Record progress
9
Know Your Reader
• At the most basic level, report writing seeks to
convince the reader that what is being said is true.
• Some reports will try to persuade the reader to take an
action or think about something in a certain way.
• Before you write, ask yourself these questions about
your reader:
1. How interested or involved in the subject is my
reader?
2. How knowledgeable is he or she on the subject?
3. What is my reader’s purpose for reading? To make
a decision? To be better informed?
10
Know Your Reader… cont’d
4. Does my reader have special concerns or
strong views about the subject? What are they?
5. How does my reader regard me personally and
professionally?
Types of Readers
There are two general types of business
readers: skimmers and skeptics.
Your documents will be most effective if you
write for both types of readers.
11
Know Your Reader … cont’d
14
The outline
• An outline has much the same use to the technical writer that a
map has to the serious traveler.
• You also need a route in order to get where you are going in
your writing.
• The route you take is your method of development. The actual
physical map that you will use is your outline.
• Like a map, your outline will help you in a number of different
ways:
1. It forces parallel structure of your ideas.
2. It allows for easy evaluation of your organization and
development.
3. It shows you completeness.
4. It save you time.
15
1. Outlining forces parallel structure of your ideas
• This simply means that ideas of equal importance get equal
emphasis.
• Ideas of lesser importance are always subordinate to some idea
of greater importance and related to that idea.
• The very act of outlining forces this.
I. First Main Idea
A First subtopic subordinate to I
B. Second subtopic subordinate to I
II. Second Main Idea
16
2. Outlining allows for easy evaluation of your
organization and development
Has a dual advantage:
1. evaluate your approach to your writing
assignment,
2. anyone who must pass approval on the writing
project can give preliminary approval.
• This has tremendous value in speeding up the
process of revising, correcting, and rewriting.
17
3. Outlining shows you completeness
• There is nothing worse than trying to write
something and getting to the end of it only to
realize that you have left something out.
• Outlining allows you to rework transitions
and make sure that what you have to move or
add fits smoothly before even writing.
• You can spot the problem quickly and make
the addition or deletion easily.
18
4. Outlining saves you time
• The greatest value in outlining and, ironically,
the most overlooked.
• Writers who outline as a regular, systematic
procedure save themselves time because the
outline will point out defects clearly and allow
their repair long before they are in final prose.
• By not taking the time to write an outline, you
probably are causing yourself the
inconvenience and aggravation of time
consuming rewrites.
19
• You can't outline in your mind.
• You must write it down on paper and follow it as you
write.
• There are basically three ways to format an outline:
1. Simple list
2. Academic outline
3. Engineering outline
20
Report Writing Components
1. Front material
2. Main Text
3. Back matter
21
DATA MANAGEMENT AND DOCUMENTATION
Presentation Agenda
• Overview of data management
• Data management checklist
• Overview….Data Vs Information
• The Data Management Cycle
• Data management
• Data Management fundamentals
• Backup, security & archiving
• Data sharing
• Factors affecting quality of data management
Brain storming
36