0% found this document useful (0 votes)
15 views30 pages

Effective Report Writing Guide

Uploaded by

sonam gurung
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPT, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
15 views30 pages

Effective Report Writing Guide

Uploaded by

sonam gurung
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPT, PDF, TXT or read online on Scribd

How to Write a

Good Report
What is a report?
• Abstract or summary
• Has a brief/specific purpose and
audience
• Section/Headings
• Data/ Graphs/ Tables
• Often text is broken u- bullet points,lists
• Written to the point
• Formal writing
The purpose....
• To communicate a research process
clearly and simply
• To give logical structure to the
methods,results and findings
• The report exists to provide the reader
with useful information
• To develop clear & concise communication
skills-useful for employment
• It succeeds if it effectively communicates
the information to the intended audience
To succeed...
The report must be
– Clear
• Well structured, clear, concise, suitable for
the intended audience
– Professional
• statistically correct, correctly spelled,
produced with a decent word processor
– Well illustrated
• illustrations that aid understanding,
integrated with text
The audience
Often 3 different audiences

– The casual reader/big boss who wants the


main message as painlessly as possible

– The interested reader who wants more


detail but doesn’t want to grapple with all
the gory technical details

– The guru who wants the whole story


What to do?
To address all 3 audiences effectively,

– Include an abstract for the big boss

– A main body for the interested non-specialist

– A technical appendix for the guru

Thus, a structure emerges!


Structure
• Good structure enhances and
encourages clarity
• Gives signposts
• implements the vital principle
– tell them what you are going to say
– Say it!
– tell them what you have said
Structure: details
A good report has the following parts
– Title
– Acknowledgments
– Table of Contents
– Abstract/executive summary
– Introduction
– Main sections( methodology, result & finding,
discussion)
– Conclusions & Recommendation
– References
– Appendices
Title
Should be informative, “punchy”, can
include puns, humour
Good
– Betty’s Burgled Bakery (punchy, alliterative)
– Diagnosing diabetes mellitus: how to test, who to test,
when to test (dramatic, informative)
Bad
– Some bounds on the distribution of certain quadratic
forms in normal random variables (boring, vague)
– Performing round off analyses of statistical algorithms
(boring, vague)
Table of Contents
• Shows the structure of the
document and lets the reader
navigate through the sections

• Include for documents more than a


few pages long.
Abstract/executive summary

Describes the problem and the


solution in a few sentences. It will
be all the big boss reads!

Remember the 2 rules


– Keep it short
– State problem and solution
The Introduction
• State the question, background the
problem
• Describe similar work
• Outline the approach
• Describe the contents of the rest of
the paper
– in Section 2 we ...
– in Section 3 we ...
Further sections
• Describe
– Data
– Methods
– Analyses
– Findings
• Don’t include too much technical
detail
• Divide up into sections, subsections
Conclusions/summary
• Summarize what has been
discovered

• Recommendation

• Give the answer


Appendix
• This is where the technical details
go
• Be as technical as you like
• Document your analysis so it can
be reproduced by others
• Include the data set if feasible
References
• Always cite (i.e. give a reference)
to other related work or
facts/opinions that you quote
How to cite
• In the text
Seber and Wild (1989) state that…..

• In the references
Seber, G.A.F and C.J. Wild. (1989).
Nonlinear Regression. New York:
Wiley.
Writing clearly
• Structure alone is not enough for
clarity – you must also write clear
sentences.
• Rules:
– Write complete short sentences
– Avoid jargon and cliché, strive for simplicity
– One theme per paragraph
– If a sentence contains maths, it still must
make sense!
AGHHHH!
• He wrote
Although solitary under normal prevailing
circumstances, raccoons may congregate
simultaneously in certain situations of
artificially enhanced resource availability.
• He meant..
Raccoons live alone but come together to
eat bait.
Maths
• Good
From the equation y ax  b it follows that
x ( y  b) / a.

• Bad

y ax  b x ( y  b) / a
Figures and Tables (Floats)
Golden rules for Figures and Tables:

• Describe float in text (integration),


make sure it matches description
• Place after the first mention in the text
• Make sure float conveys the desired
message clearly: keep it simple!
• Provide informative captions
Figures
• Always label and give a caption under the
figure
• Be aware of good graphics principles: avoid
– chart junk
– low data/ink ratio
– unlabelled axes
– broken axes
– Misleading scales
• See Cleveland, “The Elements of Graphing
Data”, “Visualising Data”
• Using a good graphics package (R!) helps
enforce good practice
African elephant
Asian elephant

8
Human

Giraffe
Horse
Chimpanzee
DonkeyCow
Gorilla
6

Rhesus monkeySheep Pig


log(Animals$brain)

Jaguar Brachiosaurus
Bad! Grey
Goatwolf
Potar monkey
Triceratops
Kangaroo Dipliodocus
4

Cat

Rabbit
Mountain beaver
2

Guinea pig
Mole
Rat
Golden hamster
0

Mouse

0 5 10

log(Animals$body)
African elephant
Asian elephant

8
Human
Giraffe Horse
Donkey
Chimpanzee Cow
6 Sheep
Gorilla
Log Brain weight (gm)

Rhesus monkey Pig


Jaguar Brachiosaurus
Potar monkey Grey wolf
Goat
Triceratops
Kangaroo Dipliodocus
4

Better! Cat

Rabbit
Mountain beaver
2

Guinea pig
Mole
Rat
Golden hamster
0

Mouse

0 5 10

Log Body weight (kg)

Figure 1. Plot of log Brain weights (gm) versus


log body weights (kg) for 28 species
Tables
• Always label and give a caption
over the table

• Be aware of rules for good tables:

– avoid vertical lines


– don’t have too many decimal places
– compare columns not rows
Multiple Prefix Symbol
1012 tera T
109 giga G Too busy
106 mega M
103 kilo K
10-1 deci d
Multiple Prefix Symbol
1012 tera T
Better
109
giga G
106 mega M
103 kilo K
10-1 deci d
Multiple 1012 109 106 103 10-1 Horizontal
Prefix tera giga mega kilo deci hard to read
Symbol T G M K d

Multiple Prefix Symbol


1012 tera T
Vertical
109
giga G
easier to read
106 mega M
103 kilo K
10-1 deci d
Number of
Time (secs)
Processors
Busy – too
1 28.35221
many DP’s
4 7.218812
8 3.634951
16 1.929347
Number of
Time (secs)
Processors
Better
1 28.35
4 7.21
8 3.63
16 1.92
Spelling and Grammar
• Use a style manual/dictionary if in
doubt
• Spell check!!!!
• Proofread!!!!
He meant…
– This technique can also be applied to the
analysis of golf balls
He typed….
– This technique cam also by applies to the
analysis or gold bills
Conclusions
• Structure is vital
• Write clearly
• Good clear simple illustrations
• Spellcheck and proofread
• Reference all material used or
quoted

You might also like