G009 Writing Reports On Line
G009 Writing Reports On Line
The water and sanitation sector can be very complex, with many different professionals
working together at different times of the project cycle. Reporting the decisions, activities
and outcomes of studies, visits, discussions and practical work helps communicate
and record important information. A well-written report is easy to read and adds to the
effectiveness of any project.
Text: Brian Reed based on the DFID-funded WELL learning module written by
Jane Bevan, Sue Coates and Rebecca Scott, with further contributions from
Hazel Jones
This guide is one of a series of published learning resources which are available for
purchase in print or available to download free of charge from the WEDC Knowledge
Base. Any part of this publication, including the illustrations (except items taken from
other publications where WEDC does not hold copyright) may be copied, reproduced
or adapted to meet local needs, without permission from the author/s or publisher,
provided the parts reproduced are distributed free, or at cost and not for commercial
ends and the source is fully acknowledged. Please send copies of any materials in
which text or illustrations have been used to WEDC at the address given below.
Introduction
The purpose of a report is to communicate findings effectively – for example the results
of research, a review of literature or recording the activities and outcomes of a visit to a
project, conference, meeting or interview.
Reports may be written at regular intervals such as an annual report to sponsors
or monthly progress reports for a project. Besides being informative, reports can
persuade people of a particular point of view, provoke discussion on an issue or initiate
change. A report is a very specific form of writing, which usually follows a clear and
formal structure.
Types of reports
Whilst there are several different types of A Terms of Reference (TOR) usually has
report, the basic format of most reports is a few paragraphs on the background of a
the same with variations in the purpose piece of work, before describing in detail
and length of the document. the work that is needed and the outputs
that are expected.
Project-based reporting
During a project, reports are required at A Baseline Study or Survey is
various stages of the cycle. sometimes requested at the beginning
of a project. This may be a strictly
A Briefing Note. External staff and other
quantitative account of existing services in
stakeholders need to ‘get up to speed’
an area, to be compared with subsequent
and quickly familiarize themselves with
improvements. It could also be a more
a country/ project/ situation. These
in-depth social record of knowledge,
are short pieces of writing (one or two
attitudes and practice (KAP), for example
pages), but can refer to other documents
if your project aims to change behaviour
as necessary. In an emergency, a rapid
in health and/ or hygiene practices.
assessment of the current situation is
required and this briefing document may Baseline surveys are an important step
be referred to as a Situation Analysis. in environmental impact assessments.
Formal site surveys are needed before
A Scoping / Feasibility Study. If a new
infrastructure developments – the reports
project or venture is being considered,
produced include considerable amounts
a preliminary step is a scoping study.
of data.
These reports examine existing services
and resources, identify where the gaps Design Reports record the next stage
are and suggest potential solutions. of the project, setting out the proposed
This report is based on written sources, project in detail, explaining why specific
interviews and site visits. decisions have been made.
2
Each type of document has its own • What do they already know
particular format that, with practice, can • How will the report be used?
aid the writing of the report in terms of
style and structure. • What should happen as a result of
the report?
Length of reports
Knowing the backgrounds, experience,
For a single project, a variety of reports
interests and other characteristics, such
may be produced for different audiences
as nationality or language, influences
the report writing. For example, when
Objectives. There are many facets writing about Asian water and sanitation
to a good report, but a key factor practices for an African or European
is that there are clear objectives. audience, certain cultural differences
By keeping these objectives in in the use of water would need to be
mind, unnecessary information will explained. If writing only for an Asian
be rejected and only that which is audience, these issues would be
needed to support the conclusions understood.
will be included. A technical report aimed at people
with a similar technical background
4
can contain specialist terms, which missing ones mean the whole report is
might otherwise be considered jargon incomplete. Some allowance needs to
and require more explanation. If it is be made for unforeseen circumstances.
for general consumption, a glossary These deadlines can always be revised,
of technical terms may be necessary. so it is useful to keep track of progress
However, it is a useful rule never to make to avoid rushing parts of the writing
too many assumptions about the readers’ unnecessarily.
understanding and always to explain why
something is a good idea. Planning the report
Many reports are based on a Terms Of
Reference (TOR), scope or brief for the
Time scale
task, that is, why the report is needed
Often the actual writing of a report is the
and by whom. The TOR will usually
part that takes the least time in the overall
contain a little background and then set
plan. Gathering the information, reading
out what is expected for completion of
the background material and selecting
the task. It can be very short, such as
the information to present can all be very
a few sentences, or quite lengthy, with
time-consuming. Checking and revising
numerous attached reports that need to
the first draft of the report can also take
be read in conjunction with the text. It
more time than expected.
usually sets out a time-scale for the work.
Delivering a report on time can be
It is important to stick to the boundaries
considered part of the ‘art’ of professional
of the objectives and not cover ground
report writing. No matter how fine the
that is not asked for. If the scope is not
report is, it will have a negative impact
clear and there is uncertainty about
on the minds of the readers if it was due
what questions the report should be
three weeks earlier. There will always be
addressing then clarification is necessary
a trade-off between the ‘ideal’ report and
before any data-gathering or writing is
the ‘good enough’ report that needs to
started. This may seem obvious, but it
be on the manager’s desk by Monday
is quite surprising how many reports do
morning. A timetable that is linked to the
not address the issues that they set out
plan is therefore an important element of
to cover.
writing a report well.
Deadlines are good to set whilst report A great deal of time is invested in
writing, to avoid endlessly striving for writing. This needs to be treated
the right wording or the perfect diagram carefully by taking a copy, keeping
and never producing the document. a back-up and making sure it does
Each chapter needs a separate deadline not get lost.
as four perfect chapters and two
5
The first draft. Often the biggest hurdle Major structural issues need to be
with writing is getting started and this finalized then the focus can move to
can be helped by writing the first draft issues of style and language. Checking
as quickly as possible – in one sitting referencing and cross-referencing is one
if possible. The bulk of the writing is of the final tasks. There may need to be
produced without detailed consideration several re-readings and revisions before
of spelling or style. the document is finally completed.
The second draft. Once the first draft is Draft final report. Once the author(s)
roughly assembled, take a break so that of the report are satisfied that the report
it can be approached with a fresh mind. is mostly complete, it can be circulated
At this stage the report is read looking at: to a few people related to the project
for comment. This allows the writer to
• the way the report addresses the check that the audience understands the
objectives; report.
• the flow of the document – seeing it if
tells a story;
discussing them and deciding what they a path that does not lead anywhere
mean. This section has to be strong, as – provided it is well supported and
it distinguishes the research report from the reasons for this conclusion fully
just a simple data collection exercise. explained.
The evidence has to be tested, looking
at arguments for and against a position, Summarizing the report
trying to prove what is “true”. The whole report may be well argued
with balance between all the different
Reaching the summit. The ultimate
facets, but this may mean that it is
purpose of the research report is to
too long for some readers. “Executive
put forward some well-supported
summaries” are written to allow a reader,
conclusions (Figure 6). The argument
such as a fellow researcher, to gain a
and evidence should be strong enough
broad overview of the project. They may
for the reader to agree and not conclude
want to go on and read the full report
that the researcher has jumped to some
or they may decide it is not what they
unsupported viewpoint.
were looking for. Some people will only
Whilst it may be desirable to come ever read this summary – hence the term
up with some new and wonderful “executive summary” to indicate that
perspective on the research subject, some decision-makers will only have the
the answer may be a “no” rather than a time to read the key points and not the
“yes”. This is still a very valid research whole report.
outcome. If after careful work, the
The art of summarizing information, or
conclusion is that something will not
précis, is a skill, which has to be learnt
work or a proposal cannot be justified,
and practised. The aim is to reduce
then this is important – especially to
a long piece of text to a few short
other researchers who can then build
paragraphs that cover all the key points.
on your work. A “no” helps them avoid
The previous points apply but the writer
has to be much more critical about what
to include.
• Write the summary from the notes. Summarizing the summary. Executive
summaries summarize a 100 page report
13
This paper discusses research which was undertaken in the author’s country. A
theoretical framework is developed from a literature search and this is used by the
authors as the basis of an analytical model. The researchers collected data within
this framework and analysed it according to the precepts laid down by earlier
researchers in the field. The data is used to demonstrate that our understanding
can be significantly increased and this is discussed in the light of previous work.
Conclusions are drawn and it is shown that these may be useful for practitioners.”
into perhaps five or ten pages. Abstracts repetitive approach reflects the
take this a stage further by reducing the organization and preparation necessary
whole topic to a few hundred words. This to communicate complex information.
distillation of the report will be read by This structure depends on the type of
many people so it needs to be concise document being produced. A short fact
but convey the main points. It may be sheet, for example, might only have an
the most important part of the report, as introduction, a main body of text and a
the best project will have no impact if conclusion.
nobody reads about it.
Title Page. The title should give a
Structuring the Report precise indication of the subject matter
Once the general flow of information has and the type of report. This section
been determined, it can be divided into also includes details of the writer, the
sections. This helps the reader navigate date, the funding agency and other
their way through the document. Many administrative data.
organizations have a standard structure
and format for their reports. The following Summary or ‘Executive’ Summary. This
are some commonly used sections: is a form of précis or shortened version
of the report, before or after the contents
• Title Page page. It should neatly and concisely
• Summary or ‘Executive’ Summary sum up the main information presented
in the report and the main conclusions
• Contents or recommendations. The summary
• Introduction should be able to stand alone from the
main body of the report – it is often the
• Main Body of Text
only part that many people read in full,
• Discussion so needs to be good. It is easier to write
when the whole report is completed.
• Conclusions, ‘Lessons Learned’ and/
or Recommendations Contents. A simple listing of all the
• References sections in the report, with their page
numbers, so that the reader can find
• Appendices
their way round the document. Figures
Some of this may seem quite repetitive, and Tables may also be listed. If you are
but formal writing structure reflects using many abbreviations and acronyms
the old adage that “if you want to tell (e.g. WEDC, UNDP), or technical terms
somebody something, tell them what (e.g. Aqua privy, infiltration gallery,
you are going to say, then say it, then non-revenue water) it may also be worth
tell them what you said.” This seemingly listing them here in a glossary.
15
• Who are my audience and what are Only include these if they are genuinely
they hoping to find out? supporting information. Appendices are
usually numbered (1, 2, 3), or can be
• How will the report be used?
lettered (A, B, C), in the order in which
• What should happen as a result of they are referred to in the text.
the report?
Reporting on projects
References. Any work quoted in the
report should be fully referenced, so that Whilst the writer knows that reports flow
readers can locate the article or book for from general introductions to specific
themselves. There are several standard recommendations, the constraints of
formats for referencing, but the most standard report structures can cause
common is to cite the author and date confusion as it not always clear what
in the text, and then to list the articles by should go in each section. “Results” and
author, alphabetically at the end of the “discussion” can often seem to merge
document. into each other, yet the former is mainly
factual and the latter sets out the author’s
Appendices. Material that is required interpretation of those facts.
for reference in the report, but would
interrupt the flow of the main body of Flow of logic
text, can go in an appendix. Examples There is a structure to the process of
are the Terms of Reference, survey projects and research, which can be
data details where the key results have illustrated using a logical framework
been presented in the text, transcripts approach (Figure 7). This logical process
of meetings or interviews, and so on. can be reflected in the report. This
Goal Recommendations
Wisdom
Purpose Conclusions
Knowledge
Inputs Results
Data
B “Currently we pay staff in the The logic is “if I carry out these activities,
regions on the 14th and 21st, and then I should produce these outputs
those in the capital at the end of (answers to questions) and from these
each month. There is a high cost should produce the anticipated research
to the organization to pay the aim, which should contribute (eventually)
accountant for three sessions a towards a wider goal”. Each stage builds
month, plus her travelling expenses. on the next.
The loss of convenience for the
The left hand side of the diagram
regional workers will be outweighed
is the foundation (introduction) and
by the necessity to reduce their
plan for the research (methodology)
hours if this practice continues. It
or project process. The activities are
is therefore recommended that we
carried out and this should result in
pay all staff on the same date each
data. After presenting the results of
month.”
the data collection, the subsequent
analysis and discussion will produce
18
Goal Recommendations
Wisdom
Purpose Conclusions
Knowledge
then pilot studies followed by fuller data • Describe a problematic issue rather
gathering. Each cycle will provide some than judging it in the text.
knowledge of what works (or does not • Be specific about the points where
work). This refinement of knowledge, there appear to be problems –
adding more detail and more depth generalizations are not helpful – and
with each iteration, is part of the wider give some constructive ideas as to
research process. how best to solve them or improve
the situation.
Evaluation reports
There is an art to constructive criticism. • Keep all criticisms ‘structural’ and
When an external evaluator reports avoid the personal.
on a project, the writing needs to be • Do not hide or erase past mistakes
approached in a very delicate and but look for the ‘Lessons Learned’
diplomatic way and particularly must be and move on.
seen to be independent and unbiased.
The evaluation report should use the
evaluator’s experience and the benefit
Writing the report
A report needs to be readable, with clear
of a fresh perspective to give advice on
and concise language, well-constructed
how the project could be enhanced.
sentences and correct spelling and
Project workers will be apprehensive grammar. The ‘tone’ of the report is
about the visit of the ‘expert’ and important – a professional report should
can quickly become defensive and be unbiased and well argued, with a
dismissive if they read new criticisms in a consistent style.
report that were not discussed with them
Everybody will write in a different way,
first in a sensitive and respectful way.
depending on their education and
Negative feedback that is not handled
experience. Report writers should be
carefully can thus be very destructive.
aware that they should adjust their
Some useful guidelines, therefore, are:
individual style to suit the report. This
• Only give opinions where they have goes beyond grammatical conventions
definitely been asked for. to include choice of vocabulary and the
• Give praise and encouragement first, tone of text. Reading other reports helps
for those parts of the work that are increase familiarity with different writing
good. styles (good and bad).
• Always tell the people involved what Whilst there are conventions about
is intended to be written – preferably writing style, the over-riding advice is
in a dialogue – so there are no “Keep It Short and Simple” – KISS. This
surprises. applies to words, sentences and reports.
20
Scientific words such as “faeces” and – provided the program is using the
“urine” are acceptable and convey the correct language. However, words can
meaning more clearly. Slang or crude still be spelt correctly, but the sense lost.
words such as “crap” and “shit” are Homophones sound the same but mean
simpler still but would not be acceptable different things (e.g. “their”, “they’re” and
in formal writing. “there”, “here” and “hear” or “practice”
(noun) and “practise” (verb)). Spell-
Spelling words correctly is less of checkers can come up with surprising
a challenge if ‘spell-checkers’ on re-wordings if you slightly mis-spell
word processing packages are used a word, for example, “brothels” for
Social scientists use the terms supply and demand to describe the way a project
is delivered. A supply-driven project is organized by those in authority and
concentrates on the delivery of services. It is measured in terms of amount of
water supplied, numbers of latrines constructed, length of irrigation canal built.
Demand-led projects concentrate on what people say they want and deliver the
request in the manner the people ask for. The practice is not as simple as the
theory. People have to be informed of the choices that are available, even to the
extent of creating “demand”. Sanitation is an example of a facility people may not
know that they want until they are told about it. Demand in this sense is difficult
to measure.
This sentence is
too long!
23
Editing Checklist