Beruflich Dokumente
Kultur Dokumente
Title
Ethics of authorship
Abstract
Acknowledgements
References
Appendices
Editing your manuscript
PUBLISHING
Submitting the manuscript
Responding to editors
Correcting proofs
Marketing the publication
INTRODUCTION
Effective writing gets results. That's the most important idea in this
manual. Many people assume that the main purpose of writing is to
convey information.
But effective writing does more than that. Behind the 'information' or
'facts', there is always something else that writers are trying to do.
next
next
next
Creating a message
CREATING A MESSAGE
Your document will be more persuasive if it has one governing idea.
Let's call this governing idea the main message. You might give your
message another name. You might, for example, call it a thesis, a
proposal, a proposition or a summary. We like the word message
because the word suggests a specific kind of idea.
next
Creating a message
At work, we write to get results. This means that thinking about the
document's subject is unhelpful. You could, after all, write huge
amounts of material about any subject. You can only narrow the
options by identifying the document's purpose: what you want it to
do.
next
Creating a message
Planning the document will be easier if you have some sense of who
your readers are and what they expect.
next
Creating a message
next
Creating a message
You can validate the message by working out a story about how it
came into being. This story may also be useful later as the core of an
introduction - in a report, for example.
next
If you can perform those two operations on your message, you will
create a structure that your reader's mind will find most natural to
understand.
So your task is to break the message into pieces and present them in
a logical sequence. This section takes you through the steps that will
allow you to do just that.
next
CREATING A STRUCTURE
Creating the structure of your document is done in two stages:
next
COLLECTING EVIDENCE
Every lawyer knows that, to persuade effectively, you need sound
evidence to support a convincing argument. To quote Rudolph Flesch,
a key teacher in effective writing: 'You'll never convince anyone by
logic alone.'
You've worked out the pyramid of your ideas. Now you need the
evidence to support them.
Does it seem odd that we should think about collecting evidence after
working out our ideas? Surely we must look at the evidence before
coming to a conclusion.
That seems to make sense. But, if you think about it, you cannot look
for any evidence unless you know what it might be evidence for. And
the only thing that evidence can support is an idea.
next
WRITING AN OUTLINE
Writing an outline is the final stage of planning your report. The outline
translates your pyramid structure into a blueprint that you can use to
prepare your first draft.
The outline isn't a first draft. It won't include all the information or
evidence you want to give, but only the principle ideas. It includes only
your message, key points, sub-points and minor points.
next
● text;
● headings;
● numbering;
● graphics.
The sentences in the outline should give you a clear idea of what to
say in each section.
next
FUNCTIONS OF PROSE
Prose is any writing that is not organised into poetic form. This entire
manual is about writing prose.
Functional prose is prose that has a job to do. Many hundreds of years
ago, the Greek philosopher Aristotle categorised the jobs that prose
can do under four broad headings. Understanding these functions of
prose helps us to write better: if we can identify what kind of writing
we're doing at any point, we can do it better.
So, what do you think prose can do? Make a list on your notebook of
all the things you can think of that writing can do.
next
EXPLANATION TECHNIQUES
Page for page, you probably write more explanation than any other
kind of writing. Instructions, examples, comparisons, accounts of how
something caused something else - all are explanation. Even proposals
will use explanation to support their advocacy at one point or another.
● Example
● Analogy
● Definition
● Categorisation
● Comparison and contrast
● Cause and effect
● Process analysis
next
Put simply, we can distinguish the summary and the introduction like
this.
next
NAVIGATION AIDS
Professional documents should contain navigation aids to help the
reader find their way around. The most important of these are the
Summary and Introduction. Others include:
● headings;
● titles;
● numbering systems.
The paper you are writing may not include all of these. Larger reports
will certainly contain many of them.
next
RESOURCE MATERIALS
Papers for academic or professional publication may include resource
materials. This indicates the resources you have used in your own
research. Your reader will want to see where your information comes
from, whose work you've referred to, who has helped you and what
you mean by special terms or abbreviations.
● References
● Bibliography
● Glossary
● Acknowledgements
● Appendices
next
USING GRAPHICS
Graphics (often called 'figures' in reports) make technical information
clearer by presenting it visually. Some simple guidelines will help you
to make the most of the power to create graphics which computers
now give to writers.
Keep your graphics simple. They should illustrate only one idea - and
the reader should be able to understand that idea immediately.
Use very few words in graphics: title, labels, scales, numbers and
essential information. Don't be tempted to add arrows or comments
within the graphic.
Place a graphic on the page where you refer to it. Make the point that
you want the picture to illustrate; present the picture; add any
discussion as appropriate.
next
ELEMENTS OF LAYOUT
Good writing needs good layout.
Until recently, writers could do little to control the way their writing
looked on the page. Now computers offer us a bewildering array of
layout techniques. Used sparingly, they can add to the impact and
quality of your document. Of course, your circumstances may limit
your options in this area. Where you can choose, this section will help
you.
next
Effective editing
EFFECTIVE EDITING
The aim of editing is to make your first draft easier to read.
The words on the page should never get in the way of your meaning.
The reader should never have to stop at any point and wonder what
you are saying.
Language is like a window through which your reader can see what
you mean. Editing is like polishing the window. It usually means
taking away the words that you don't need. You should be aiming to
make your language transparently clear.
next
Effective editing
GENERAL PRINCIPLES
Good editing means making wise choices. What words should you use?
What order do you put them in? There is never a single correct
answer.
next
Effective editing
Use a new paragraph for each new idea. Every time you take a step,
say something new or change direction, you should start a new
paragraph.
next
Effective editing
The best sentences are sturdy and straightforward. The reader can
understand them easily, without having to reread them. Sentences
become difficult to read for two main reasons.
next
Effective editing
The main reason for this huge choice is that English is, and always has
been, a hybrid language. It emerged as a mixture of three languages -
Anglo-Saxon, French and Latin - and it has continued to absorb words
from other languages ever since: from Arabic, Greek, Turkish, Hindi,
Chinese and Persian, to name only a few.
next
Introduction
INTRODUCTION
Writing papers for academic or scientific journals requires particular
skills. You certainly need to be able to write well, using all the skills
you acquired through studying the section on Effective Writing: core
skills. But writing for journals is different from other forms of writing.
next
Introduction
Whenever you produce a report, you are effectively the publisher. You
have the freedom to decide what you will include, its length, the
amount of graphical information, its format, style and content.
next
Introduction
To get the most out of this manual, you should have already
completed your research and data analyses and be ready to prepare a
manuscript for publication.
next
We can imagine how you feel. You have spent months, if not years,
researching. You are faced with mounds of notes, computer print-outs,
analyses, tables, graphs, papers. Where do you begin?
next
WHY PUBLISH
Publication in academic or scientific journals may be important for
several reasons.
next
WHAT TO PUBLISH
We can broadly divide publications into two types:
next
'Wait a moment!', we can hear you say, 'I'm a researcher. This isn't
propaganda! What do you mean message?'
next
YOUR READERSHIP
Writing is about communicating with others. If you want to do it well,
it helps to know who you are communicating with.
Think about what you did last week and describe it in:
Do you agree that the way you write - and perhaps even what you say
was different in each case?
next
WHERE TO PUBLISH
Deciding which journal you should send your manuscript to needs
careful thought. Where should you publish your paper?
Many people leave the decision until they have written the paper. That
is fine if you are experienced in publishing. You probably have an idea
of two or three potential journals to whom you might send your
manuscript.
But if you are a new to publishing, the more certain you are about
which journal you are targeting, the easier it is to write the paper.
The following will help you work out which is the most appropriate and
suitable journal for the paper you are planning to write.
next
Preparing an outline
PREPARING AN OUTLINE
Before you can start writing your paper, you should develop the
skeleton around which you will build it.
We will work on the outline in two stages. Here we will guide you
through preparing a quick sketch of your outline. Doing this will help
you to gain an overview of your paper. Once you get into the details, it
is easy to lose sight of the paper as a whole.
When you come to writing the first draft, we will guide you through
putting in the detail.
next
Preparing an outline
TYPES OF PAPERS
Papers developing ideas or theories
Preparing an outline
Write out that sentence at the top of a blank piece of paper in large
letters. This is going to be the heart of your paper. Everything you say
will be written to support this one key message.
Once you have done that, click on the forward button to move to the
next screen.
next
Preparing an outline
next
Preparing an outline
Sampling: How was the sample obtained? Were there any special
methods that need to be mentioned which may have a bearing on the
interpretation of the findings?
next
Preparing an outline
PRINCIPAL FINDINGS
Your message sentence probably encapsulates the most important
findings. There may be others that you feel ought to be included.
List these in note form. For the present don't worry about the order or
how many you put down.
next
Preparing an outline
CONCLUSIONS/IMPLICATIONS
What are the principal implications of your findings? What actions, if
any, would you propose should be taken by other researchers in the
light of what you have found? Are there any changes in practice,
approaches or techniques that you would recommend?
Make brief notes on each of the implications that you think arise from
your study. List them without editing or worrying about the order.
next
Preparing an outline
INTRODUCTION
Before you begin on the introduction, stop and read through the notes
you have made so far in your outline. Read them through and see
whether there is a coherent story, a unifying theme that runs through
the outline. Is there a story there? Does it knit together well?
Your outline should start with the main message, describe what the
purpose or objective of your study was, how you went about doing the
study, what you found and what are the implications of what you
found. If the story outline is there, then it should all point towards
your main message.
If your outline doesn't 'tell a story', you may need to do some work on
it before you prepare your outline introduction.
next
Writing the first draft. We will then look at how to write the paper,
taking account of the requirements of journals that manuscripts be
written in a particular style.
next
next
INTRODUCTION
The introduction should provide the reader with enough information to
allow them to understand and evaluate why it was necessary to carry
out the study.
The introduction takes the reader from what they already know to
what you want to tell them. By the end of the introduction, the reader
will be persuaded that there is an important problem to be addressed
and will understand the context of your main message.
So, how will you do all this? You will use the SPQR that you prepared
in your outline and elaborate upon it. As you do so, ask yourself:
'What do I need to include in the introduction to help me convey the
main message effectively?'
We provide you with a list of questions that you should consider as you
write.
next
How much should you include? This is the part that new researchers
most often get wrong. They believe that everything that was done or
used in the study should be described in detail. It shouldn't.
The clue to writing the materials and methods is to ask: how little
information do I need to provide to allow another competent
scientist, a specialist in my field, to repeat the study or experiment?
Such a person will be familiar with most of the commonly used
techniques. You may need to include references to literature that
describes an unusual technique. But only provide a description if you
have developed a new technique or extensively modified existing ones.
next
RESULTS
The purpose of the results section is to present only those results that
are strictly necessary in order to justify your conclusions - your main
message.
● This is not the place to present all the data that you have
collected.
● This is not the place to present the results of every bit of
analysis that you have valiantly performed. The place for those is
in your field or laboratory notebooks.
No doubt you have laboured for months (if not years) producing the
results of your study. You know them intimately. You've looked at
them in all kinds of ways. You are keen to show how well you've done,
how you've thought of everything. You are dying to get this down on
paper.
next
DISCUSSION
The main purpose of the discussion is to:
next
Set aside some quiet time when you can write the first draft in peace.
next
WRITING STYLE
Writing for journals is different from most other forms of writing
because journals insist on a uniformity of style in the papers that they
publish.
next
● a title;
● a list of authors;
● an abstract;
● acknowledgements;
● references;
● a final edit.
next
Understanding advocacy
UNDERSTANDING ADVOCACY
Advocacy is persuading people to take action. It's about
recommending, supporting, challenging or defending ideas.
Our main focus in Effective writing: core skills was how to write
effective professional reports. In Writing for science we discussed
how to write effectively for publication in the scientific or
academic press. Here, we look at how to write effectively for non-
specialist audiences.
next
Understanding advocacy
next
Understanding advocacy
You have already taken important steps towards defining that. Let's
develop further the example we used.
Call up the notepad in which you made your list of 'who needs to
know' and 'what you want them to do'. Next to each, note down what
you think might be the most appropriate form of written
communication you might use to convey your message.
Done?
next
Understanding advocacy
If you need to, go back to that section now to refresh your memory.
next
Understanding advocacy
next
Understanding advocacy
PARADIGMS
We are all persuaded by evidence that fits the paradigms governing
our own behaviour. Paradigms (another name might be mindsets) are
the deep values by which we live. They are the patterns through which
we see reality and make sense of our lives. They might be:
next
next
ARTICLES
Articles are pieces of writing for publication in:
● newsletters;
● newspapers;
● magazines;
● journals.
next
LEAFLETS
Leaflets are for delivering useful, reusable information.
They are normally created from a single sheet of paper, folded in half
or in three. Most leaflets start life as sheets of A4 paper, but you could
create one from A3 (twice the size of A4), folded as appropriate. The
size and shape of the leaflet is a major factor in its success. A leaflet
that people can't fit easily into a pocket or a bag will be thrown away.
Leaflets may also not be suitable for audiences who don't read much.
Of course, you could create a leaflet that uses mainly - or only -
pictures.
next
NEWSLETTERS
Newsletters keep people in touch with what your organisation is doing.
They communicate both to the members of the organisation and,
often, to interested outsiders.
next
PAMPHLETS
Pamphlets are usually booklets that argue a case. They are the means
by which we explain the rationale behind a campaign, the values that
lie behind it.
Pamphlets are usually small - about the size of the User's guide
accompanying this CDROM - and made up of a number of pages bound
or stapled together.
next
PRESS RELEASES
Press releases send newsworthy information to media editors.
The aim of a press release is to give the editor something to work with
or from. You should not aim to write the story or article for them.
Press releases must be accurate - but they must also sell the material.
It's easier to sell one idea than many, so - as with any other kind of
effective writing - focus on one idea.
next
POSTERS
Posters are fairly cheap and easy to produce. Use them to give people
information about meetings, organisations, events and issues.
Most posters are designed to be read quickly. They need to make their
mark immediately. Others - intended for offices, libraries or other
places where people have a little time to stand and read - at a bus
stop or railway station perhaps - can contain lots of information.
Most posters mix writing, graphics and illustrations. You could consider
using only one of these elements for added effect.
next
Resources
Resources
Useful websites
Recommended reading
Resources
RECOMMENDED READING
Anderson J and Poole M, Thesis and Assignment Writing, John Wiley,
1994.
Becker H, Tricks of the Trade: how to think about your research while
you're doing it, University of Chicago Press, 1998.
next
Resources
Journals
Magazines/Newsletters
Resources
USEFUL WEBSITES
AROW: http://www.cgiar.org/isnar/arow/index.htm Agricultural
Research Organisations on the Web (AROW) contains a worldwide
directory of organisations and universities working in agricultural
research that have a home page on the Web. It continues to develop
this directory with new listings being added all the time and old listings
being updated or deleted.
next
Help
How to navigate
Help
INTRODUCTION
The following notes are drawn from handouts developed for Writing
for change trainers' workshops. They should be used in conjunction
with, and as a complement to, the Users' guide that comes with this
CDROM.
next
Help
HOW TO NAVIGATE
Each page of the manual is designed with the following features:
`
next
Help
next
About us
About us
fahamu
Authors
Acknowledgements
IDRC
About us
fahamu
Established in 1997, fahamu seeks to strengthen the capacity of
nongovernmental organisations in the third world through exploiting
the potentials of information and communications technologies.
The word 'fahamu' comes from the Kiswahili word for understanding or
knowledge.
next
About us
THE AUTHORS
● Alan Barker is managing partner of Direction, a learning
consultancy that works to develop creativity and skilled
communication. He is also the author of How to be Better at
Managing People, How to be a Better Decision Maker (both
published by Kogan Page) as well as several books published by
The Industrial Society.
● Firoze Manji is director of fahamu. A Kenyan, he has more than
20 years work experience in development. He has worked for a
number of international agencies including the International
Development Research Centre, the Aga Khan Foundation and
Amnesty International. He is Visiting Fellow at Kellog College,
University of Oxford.
next
About us
ACKNOWLEDGEMENTS
The authors wish to thank: Shereen Karmali, who wrote the section on
proof-reading and edited various drafts; Anna Feldman for preparing
earlier outlines of Writing for advocacy; and Catherine Thompson for
copy-editing. Thanks also to John Pilbeam (University of Oxford) for
his help in preparing the CDROM for use on Macintosh computers.
next
About us
ABOUT IDRC
next
TITLE
Your title will be read by many more people than the rest of your
document. Hundreds - maybe thousands - of people may see your
document's title without reading or even seeing the document itself.
Librarians, indexing and abstracting services will use this short group
of words to classify the paper. Other authors who cite your paper will
include the title in their list of references, which, in turn, will be read
by thousands of readers.
Your title may also be the means by which readers find your
document. Apart from those who will read it at the head of the
document itself, the title may appear in indexes, literature-retrieval
systems and search engines. You should consider how these systems
will be able to manage the title you propose.
next
ETHICS OF AUTHORSHIP
How does one decide on authorship? Perhaps no other issue results in
as much conflict and acrimony as the process of deciding who should
be cited as an author. Such problems can be avoided if thought is
given to defining what role each person has played in the research
process, what it means to be an author, understanding who owns the
data and having clarity about rights and responsibilities of publishing.
Understanding these issues allows you to plan authorship in a way that
brings benefits to all those involved, while maintaining your integrity
and intellectual honesty about the extent to which different people
have been involved in the work.
Let us look at some of the issues you should consider when planning
authorship. (We are indebted to Don Peden for providing thoughtful
material upon which much of the following is based.)
next
ABSTRACT
'Abstract' is the slightly pompous title for a summary. It is a summary
of your paper. It should be no longer than about 400 words. It says
everything that you want to say in the document, without including
any detail.
Obviously, your abstract should contain only ideas that are also in the
document.
next
ACKNOWLEDGEMENTS
The purpose of the acknowledgement section is to thank people. The
production of knowledge involves a large number of individuals and
institutions. Different people give their labour (intellectual or manual)
to every aspect of scientific work. The input of all those who contribute
substantially should be acknowledged.
next
REFERENCES
The purpose of the references section is to provide readers with
precise details of the literature you have cited so they are able to find
these papers with ease. The purpose is not to demonstrate either how
erudite you are or to show how much you have read.
You should cite in your paper only references to the most important
publications. You should not aim to be comprehensive.
next
APPENDICES
Our advice: do not use appendices in journal articles.
next
● Take a break before you start editing. Set your first draft
aside and do something else before editing it. This will allow you
to look at what you've written more independently - as if you
hadn't written it.
● Ask for a second opinion. Give your work to a colleague or
friend, whose opinion you respect. It's important, however, that
you make the final editing choices.
next
Publishing
PUBLISHING
The next stage involves submitting the paper to the journal of your
choice.
You should refer to the journal's guidelines for authors to makes sure
you comply precisely with the instructions.
next
Publishing
next
Publishing
RESPONDING TO EDITORS
Some time after submitting your manuscript, you will receive
comments from the editor. This will usually comprise a letter
accompanied by comments from referees. Normally, you will not be
told the identity of the referees.
You must brace yourself. None of us ever open the letter without some
anxiety.
No-one, not even the strongest of us, likes to be told that our work is
less than perfect. It is painful. In the majority of cases, editors (and
reviewers) will be trying to help you produce high quality science.
Feedback from the editors and referees is a dish best eaten cold.
Never respond immediately. Give yourself a few days to reflect.
Editors will do their best to be courteous and gentle, but they also
need to be clear to avoid being misunderstood. This can be difficult.
next
Publishing
CORRECTING PROOFS
When your paper is finally accepted for publication, the editor may
make a number of changes to it:
You will be sent a copy of the proofs and asked to check them carefully
for any errors.
next
Publishing
There is so much published every day that even the most hard
working scientist will not read everything that they ought to. How will
they know, unless they were specifically looking for your paper, that
you have just made an important contribution to knowledge in your
field?
Well, you could take the trouble to draw their attention to the paper.
One way of doing that is to send people a copy of your paper. Don't
feel shy about doing so. You are doing them a favour: they won't need
to search for it or photocopy it in the library.
But who should you send it to? You can't send it to everyone. Clearly
you must make a decision about who is important.
next
● Creating a message
● Organising your ideas
● Writing the first draft
● Editing for greater clarity
This module takes you through each stage in turn and helps you to
produce a document that will get the results you want.
next
Creating a message
next
Creating a message
Because the message is the most important idea in your work, you
need to spend some time working out what it is and checking that it's
appropriate: for you, for the reader and for your purpose.
next
Creating a message
Creating a message
Make your purpose as specific as you can. In this section, we'll look at
some useful words to define different kinds of purpose.
next
Creating a message
Creating a message
I want..
or
or
I want to achieve..
next
Creating a message
Managing expectations
Creating a message
Think about all the people who will or might see this document. Make
a list of all the readers you can think of.
next
Creating a message
Managing expectations
Think about your primary readership and put yourself into their
position. Asking some or all of these questions will help you write more
directly and persuasively.
next
Creating a message
● background;
● strategy, priorities or driving values;
● place in the organisation;
● relationship to the social environment.
next
Creating a message
Creating a message
Now, think about your primary readership. Who are they? What do
they expect? Which key persuasive factors do you think will most
strongly influence them?
next
Creating a message
An effective message:
next
Creating a message
The story follows four stages. We can remember this sequence using
the acronym SPQR (which you may remember from history lessons as
the motto of the Roman Republic...Senatus Populusque Romani -
meaning the Senate and People of Rome).
● Situation
● Problem
● Question
● Response
next
Creating a message
Situation
Problem
Question
Response
The beauty of this process is that the structure you create to display
your ideas is always the same. And that structure is a pyramid.
next
Creating a structure
Collecting evidence
Writing an outline
next
next
next
Altering an idea may affect its place in the pyramid or even the
structure of the pyramid itself. Be prepared to change the structure of
your ideas as you find more evidence. But be prepared also to limit the
range of your research to those areas that directly relate to your
argument.
next
Principles of outlining
Principles of outlining
Then write each key point sentence, numbered, in order, with each
sub-point and minor point numbered beneath each key point. Use a
decimal numbering system for maximum clarity:
1.
1.1
1.1.1
and so on.
Add a title for the whole outline. At this stage, other headings are
unnecessary.
next
It shows you clearly - on one page - what points you want to make,
and how they fit together.
You can use the outline to alter the structure of your ideas, without
changing lots of text.
next
Once you have prepared your outline, you should use the following
checklist to improve it as necessary.
next
next
next
Functions of prose
Explanation techniques
We explore six types of explanation and how you can use them.
Navigation aids
Resource materials
Using graphics
Elements of layout
Here are some of the actions that you might have included in your list.
next
For a start, there are certain things that prose cannot do. For example,
prose can't think - you can, but your writing can't. So, in our list, these
actions are actually impossible for prose to achieve.
next
Example
Analogy
Definition
Categorisation
Process analysis
Example
next
Analogy
You must be confident that the analogy will hold: that the parallel you
are drawing is accurate. Consider:
This analogy fails because a floppy disk does not drive the computer.
Can you find a better analogy here?
next
Definition
next
Categorisation
Every item under consideration should fit into one of your categories.
If you have odd items left over, add other categories or rework your
existing categories.
Items should fit into only one category. If you cannot decide where to
put something, ask yourself if it can be eliminated as irrelevant, or
whether it needs a category to itself.
next
next
next
Process analysis
next
Summary
Introduction
Summary
Obviously, your summary should contain only ideas that are also in
the document. Any idea in the summary must also be in the document
itself.
The summary comes at the very start of a document. The usual page
order is:
Title page
Summary
Contents list
Introduction
next
Introduction
At its heart is SPQR: the story of how the document came into being.
For more on SPQR, look again at the section headed Checking the
message.
next
Headings
Titles
Numbering systems
Headings
Headings are prominent navigation aids and you should use them
carefully. Individually, they can give the reader an immediate
indication of what they will see in each section; together, they are a
set of signposts that show what the whole document covers.
Perhaps the most important rule in using headings is: don't overdo
it.
Use headings only if they will clarify your meaning, and the structure
of your ideas. Too many headings may make reading difficult.
A good heading has high scanning value. It conveys a lot in a very few
words: vital when the reader is scanning the document at speed. A
heading should be accurate, specific, attention-grabbing and concise.
next
Titles
The form of the title will depend on the type of document you are
producing. A poster, an article, a leaflet, a business document and a
scientific paper will each have a title: its style will be different in each
case.
Your title will be read by far more people than the rest of your
document. Hundreds - maybe thousands - of people may see your
document's title without reading or even seeing the document itself.
next
Numbering systems
The two main systems of numbering that you could use are:
1. Page numbering
2. Section numbering
next
References
Bibliography
Glossary
Acknowledgements
Appendices
References
● books;
● periodicals;
● published reports;
● in-house reports;
● websites;
● minutes of meetings;
● proceedings of conferences;
● theses, dissertations or other academic papers;
● personal communications.
next
Bibliography
A bibliography lists material that you have used but not referred to
directly in your paper. You might also include material that you think
your reader may find useful or interesting. You should separate these
two categories into two lists.
next
Glossary
You should also list acronyms and abbreviations in the same way as a
glossary - and for the same reasons.
next
Acknowledgements
next
Appendices
Appendices are useful for including material that does not directly
support the main ideas in your document.
next
● Bullet points
● Tables
● Graphs
● Pie charts
● Bar charts
● Flow charts
In this section, we'll look at how these powerful graphic devices can
help you to explain complex information and support your key ideas.
next
Bullet points
Tables
Graphs
Pie charts
Bar charts
Flow charts
Good layout makes your writing easier to read and more inviting to the
eye. The three key elements of good layout are:
next
Highlighting
Effective editing
● Take a break before you start editing. Set your first draft
aside and do something else before editing it. This will allow you
to look at what you've written more objectively - as if you hadn't
written it.
● Ask for a second opinion. Give your work to a colleague or
friend whose opinion you respect. It's important that you retain
the final editing choice.
● Edit on paper, not on screen. You can look at text on paper
more objectively.
● Edit for clarity. That means using plain English.
● Edit systematically. The most efficient approach is to edit the
text on three levels: paragraphs, sentences and words Trying to
improve your work word by word is time-consuming and tedious.
next
Effective editing
Editing systematically
In this way, you edit the largest units of meaning in your text first.
Problems at the sentence and word level will tend to disappear as you
edit paragraphs; other problems at the word level will fall away as you
edit sentences. Editing systematically means that you get maximum
benefit for minimum effort.
next
Effective editing
Effective editing
Effective editing
Using a topic sentence helps you to decide what material to put in the
paragraph. Only ideas that support the topic sentence have a place
there. Your outline - if you've written one - is a ready source of topic
sentences.
next
Effective editing
next
Effective editing
Your paragraphs should make sense in order. There are two ways to
ensure that they do.
A list of common link words and phrases are shown on the next page.
next
Effective editing
Key words are words that bind a paragraph together and help the
reader to connect one paragraph to the next. Some words will be at
the heart of what you want to say; don't be afraid to repeat them.
next
Effective editing
Paragraph layout
next
Effective editing
Use bullet points sparingly. They are very strong visual devices. You
may destroy the effect if you:
More and more writers use bullet points, but few use them well. So
let's see how to do the job properly.
next
Effective editing
next
Effective editing
● Simple sentence
● Compound sentence
● Complex sentence
next
Effective editing
next
Effective editing
Introduction
next
Introduction
● You can't write about anything you want - you can only write
about what a particular journal is interested in. Each journal
publishes papers on an extremely limited range of subjects.
● You can't write for whoever you want: your primary readership is
defined for you.
● You can't choose your own style of writing: it is set by
established standards, rules and conventions.
● You can't chose you own layout or format: these are determined
by the publisher and designed to make every paper look the
same.
next
Introduction
next
Introduction
next
Introduction
Before starting to write, you will find it helpful to clarify for yourself:
next
Introduction
2. Preparing an outline
Your next step is to quickly sketch the outline of your paper. This will
help clarify your thinking and establish a framework for writing your
paper.
next
To construct a concept of the paper you want to write, you must ask
yourself these questions:
next
Why publish
What to publish
Your readership
Where to publish
next
Perhaps you have other reasons for wanting to publish. This is a good
time to write down your reasons.
next
next
But you also need to be clear what exactly you want to convey about
the subject. The clearer you are, the easier it will be to write and the
more likely it is to be published.
True, your paper will present data. But which data you select for
inclusion, and even how you present it, will be determined by what
message or argument you are trying to convey. That message may,
for example, be an answer to the hypothesis underlying your study.
next
Spend some time working this out. Get this right and the writing is
easy
The examples of 'key message sentences' on the next page may help
you to formulate your own.
next
The same principle applies to writing for journals. You need to know
who you are writing for before you can decide what you will say and
how you will say it.
Think about the paper you are planning to write. Do you think your
primary readership comprises:
● policy makers?
● readers of the journal?
● your juniors?
● your professional colleagues?
● your professor or your boss?
● your family?
● someone else?
next
Did you choose 'readers of the journal'? Most people who are shown
this list don't make that choice.
True, you may want to use the publication to target people beyond
that constituency. You may want to influence policy makers or impress
your colleagues, boss, professor or family. But from the point of view
of writing for publication, these people should be considered as
secondary readers.
next
If you send your manuscript to the 'wrong' journal, your paper could
be:
next
Ask yourself these questions to help you decide which journal you
should submit your paper to.
next
Preparing an outline
To write well, you need an outline. To prepare an outline, you will need
to make notes on the following:
We will explain why you should write your outline in that order.
next
Preparing an outline
Types of papers
Principal findings
Conclusions
Introduction
Preparing an outline
There are two types of papers that you can write for scientific
publications:
next
Preparing an outline
next
Preparing an outline
next
Preparing an outline
● Introduction
● Materials and methods
● Results
● Discussion
Here we will suggest how you can approach preparing an outline for
each section.
Although the Introduction will eventually be the first part of the paper,
our advice is to leave preparing the outline of the introduction to the
end. Many people do it that way, which is why introductions are often
referred to as 'post facto justifications for what follows'.
next
Preparing an outline
Materials: List the materials used in the study and what they were
used for.
Methods: Briefly list the methods used in your study, including any
special data analysis techniques. In other words, describe briefly how
you carried out your investigation.
next
Preparing an outline
Now let's look at how you sketch out the outline of the introduction.
● Situation
● Problem
● Question
● Response
Imagine that you want to explain why you did the study to someone
who knows nothing about your work or your field of expertise.
How would you go about doing so? What would you need to explain to
them?
next
Preparing an outline
Using the four headings (SPQR), write one or two sentences next to
each that explains in non-technical language:
Now look at your main message. Is the main message the final
'punchline' of your introduction? If it isn't, then you need to work on
the 'story' in your introduction so that it all leads to your main
message.
next
Introduction
Results
Illustrating data
Discussion
ILLUSTRATING DATA
In the days of powerful computers and graphic printers, it is tempting
to include many graphs or illustrations. Don't be tempted. They are
great for verbal presentations and for reports. But be very cautious
about including graphs and illustrations in papers destined for
publication.
Avoid tables, graphs and illustrations if you can. Use tables, graphs
and illustrations only to present data which would be both too complex
and tedious to describe in words.
next
Situation
Problem
Question
Response
Summarising
Situation
● How would you describe the current situation (before you did the
study) in a way that will be familiar to the reader?
● How can it be best described from the primary reader's point of
view?
● Which are the most important and pertinent references to cite
and which will the reader expect you to include?
● Have you demonstrated that you are sufficiently familiar with the
relevant literature?
● Can you summarise the relevant findings of previous studies in
the fewest words? You don't need to describe each study. Simply
summarise the most important findings.
next
Problem
● What is the key problem that this paper seeks to address? Can
you express it in a single sentence?
You might find that you can rephrase your main message sentence in
the form of a problem statement. For example, supposing your
message sentence reads: 'Women farmers are creditworthy because
more than 90% were able to repay their loans within three years', you
might express your problem statement as: 'Women farmers are unable
to obtain loans because they are not considered creditworthy by
financial institutions in the region.'
Be careful that you don't express the problem statement in a way that
causes the reader to react negatively.
next
Question
Women farmers are unable to obtain loans because they are not
considered creditworthy by financial institutions in the region.
provokes the questions:
These are the questions that, presumably, your study will seek to
answer.
next
Response
next
Summarising
SPQR provides you with the main elements of your introduction. You
should be able to write it in about four paragraphs (avoid lengthy
introductions - your reader's attention might drift).
next
next
Population
Sampling
Materials
Methods
Data analysis
Ethical concerns
Right? Fine, write down all you want. Get it out of your system. Then
put it away. It's not what you will need for this publication.
But you only have space for what is essential to support your
conclusions. Use that space well.
next
in your data. Editors and readers have neither the stamina for, nor
interest in, wading through mountains of data in order to find that little
nugget of wisdom. The task of sifting the sands is yours, not the
reader's.
next
Principal conclusions
Assessment
Implications
Principal conclusions
In the introduction, you set the context for the study, justifying why it
needed to be done. In the materials and methods section you
described how you did it. In the results you describe what you found.
The burning question in the reader's mind will be, 'So what?'
next
Assessment
Consider:
next
Implications
next
Explain whether there are still gaps in knowledge that need to be filled
by further research or which arise as a consequence of what you
found. Make notes on the following.
● Are there any new hypotheses arising from your study? If so,
what are they?
● What are the most important, relevant, issues that remain
unresolved as a result of these findings?
● Does anything need to be done to confirm or test the results?
● Are you presently investigating issues that are directly relevant to
these findings? Be careful. If you don't know the outcome of that
research, how much do you want to reveal here? If you know the
outcome, do you want to reveal it here? Would the editor or
referees consider your paper incomplete without the results of
that research?
next
● These are the places where busy people tend to look to get a
flavour of a paper.
● It's a classic technique of communication. As the army sergeant
major put it: 'First I tells them what I'm going to tell them; then I
tells them; and then I tells them what I told them'.
next
Write quickly. Don't ponder over words. Keep going. Leave gaps if
necessary. Aim for a natural flow.
Write in your own voice. Expressing yourself in your own way will
help you to say what you mean more exactly. It will be easier for your
reader if they can 'hear' your voice.
Write without interruption. Try to find a time and place where you
can think and write without distractions.
Write without editing. Don't try to get it right first time. Resist the
temptation to edit as you go. You will tend to get stuck and waste
time.
Keep to the plan of your outline. Use the sentences from your
outline to focus what you want to say. If you find yourself wandering
from the point, stop and move on to the next sentence in the outline.
next
Verb tense
We, I or it?
Brevity
Verb tense
When you report what you found or what you did, or what happened
in your study, you always use the past tense.
next
We, I or it?
instead of
You will find many publications in which authors use the passive voice
because they believe they are demonstrating their objectivity, that
they are presenting data in a neutral way. Although some editors still
prefer the passive voice, a growing number will permit, or insist that
you use, the active voice. Researchers should, they believe, take
responsibility for their work by using 'I' or 'we'.
next
We suspect that you are a busy person. Your desk is probably piled
with papers, letters to be replied to and memos to be answered. You
don't always have the time to read as much as you should.
Not all parts of published papers get the same attention. If you know
how people read, you can write in a way that ensures that you convey
your main message effectively.
next
Brevity
Be brief.
next
Title
Authors
Abstract
Acknowledgements
References
Appendices
Final editing
Understanding advocacy
As with all forms of effective writing, before you begin to write you
must:
next
Understanding advocacy
Constructing a message
Paradigms
Understanding advocacy
next
Understanding advocacy
Example
Write down your ideas. Our thoughts on this are shown on the next
page.
next
Understanding advocacy
next
Understanding advocacy
Even where there are high literacy levels (as in many developed
countries), writing is not necessarily the most effective form of
communicating ideas. (How to use other non-written forms of
communication is a subject that falls outside the scope of this
manual.)
next
Understanding advocacy
Look at the next section of the menu for more on hearts and minds.
next
Understanding advocacy
Like all of us, however, people whose attention we are trying to attract
have other things on their mind. There may be many others who are
competing for their attention. Why should they read what you have
written? What's so special about you? Even if they see what you write,
will they read it? And if they read it, will they understand it? And if
they understand it, will they do what you want them to do?
next
Understanding advocacy
next
Understanding advocacy
ADDRESSING A PARADIGM
next
Understanding advocacy
You can address a paradigm directly. For example, if you know that
your audience makes decisions primarily on cost, you might construct
a campaign, a message and a set of information that demonstrates
how cost-effective a particular solution is. If the community is
governed by powerful social paradigms - about the social or cultural
significance of a crop, for example - you might appeal directly to that
paradigm by showing how that value is under threat.
next
There is, of course, one major medium missing from our list: the
Internet.
next
next
Articles
Leaflets
Newsletters
Pamphlets
Press releases
Posters
next
Planning an article
Writing an article
Publishing an article
Planning a leaflet
Designing a leaflet
Producing a leaflet
Distributing a leaflet
next
PLANNING A LEAFLET
Think of your leaflet as having a few key elements:
● headline;
● short sentences or bulleted lists;
● brief explanatory text;
● pictures.
next
DESIGNING A LEAFLET
Laying out a leaflet can be a daunting task. It is also a crucial one, as
it can make the difference between your precious content information
being read or ignored.
A good way to approach layout is to try and think about your leaflet in
terms of its different components. These should include any or all of
the following:
● a main headline in large, bold text, that links directly with the
leaflet's main message;
● your organisation or campaign logo and/or motto, so you can
develop an image that people associate with your work;
● the name of your organisation or campaign, so everyone knows
who the leaflet is from;
● the main body content - either in pictures, words, or both.
next
PRODUCING A LEAFLET
The best way to produce a leaflet is on a computer. A good
wordprocessing or desktop publishing programme will produce
excellent results with a little practice.
Alternatively, you could take your work to an agency who will lay it out
for you. This can be expensive, but you may be able to justify the cost
against time or effort. As always, the true cost of using outside agents
is that you and your colleagues don't develop your own skills.
next
DISTRIBUTING A LEAFLET
Apart from their size, it is the distribution of leaflets which really
distinguishes them from posters.
next
Newsletters are not as easy to produce as you might imagine. You can
produce them quite cheaply, but many organisations have difficulty:
● meeting deadlines;
● gathering enough material to fill a newsletter;
● publishing the newsletter regularly;
● maintaining interest in a regular publication.
next
next
next
Planning a pamphlet
Remember that press releases are useful, not only for national or local
broadcasting organisations and newspapers, or large-circulation
magazines, but also for in-house publications: newsletters and
bulletins within organisations or communities.
Remember that a press release is not intended as final copy: it's for an
editor to turn your press release into the style and format that their
publication needs. Think of a press release rather as raw material:
structured, but not yet cooked.
next
Once you know what event you are highlighting, other information will
tend to fall into place.
next
next
next
Planning a poster
Designing a poster
Printing a poster
Distributing a poster
next
next
next
next
next
Resources
next
Resources
next
Resources
JOURNALS
Title: AMBIO
Email: elisabet@ambio.kva.se
next
Resources
MAGAZINES/NEWSLETTERS
Title: DOWN TO EARTH: Science and Environment Forthnightly
Bi-weekly publications.
Comments: cse@unv.ernet.in
next
Resources
next
Resources
Guidelines are available on inside front and back cover of the journal
(December 1998).
Where to submit: Copies should be sent to one of the editors (4). Their
names and addresses are provided on the 2nd page of the journal.
Comments: http://www.wkap.nl/
next
Resources
Title: CURRENTS
Quarterly publications.
Email: Katarina.Toborn@lbutv.slu.se
next
Resources
next
Help
next
Help
GENERAL PRINCIPLES
● Adult learners are volunteers - no one has (usually) forced them
to attend. They usually come with their own reasons for learning
and have their own priorities and views about why something is
important to them.
● They come with the intention of learning - so you need to keep
them motivated.
● They come with experience, and therefore can contribute to the
process of learning - draw on their experiences.
● They learn best when they are actively involved and when they
can participate.
● They learn best when the training provides practical benefits for
their own work.
● They usually have diverse backgrounds - exploit these to provide
different perspectives on each problem.
next
Help
Effective learning
next
Help
fahamu
next
About us
fahamu
Registered offices: Buxton Court, 3 West Way, Oxford OX2 0SZ UK.
next
About us
Our thanks to the many who participated in field testing of the manual
at various sites. In particular, we would like to thank the participants
and trainers at workshops held in Hyderabad, India, for their
enthusiastic support and helpful comments.
next
About us
next
About us
Our thanks to Jan Goyvaerts for permission to include EditPad with this
CDROM.
next
About us
HOW TO REACH US
next
An improperly titled paper may be lost and never reach its intended
audience.
next
is vague. It does not reveal anything about the nature of the study.
is considered too sensational for a scientific paper. The title could be re-
phrased as:
This provides some indication of the concern without using terms such
as 'significant'. Notice that redundant words, such as verbs and
articles, have been eliminated, so that the title functions as a label
rather than a sentence.
next
next
Defining authorship
next
next
next
next
You must refer to the instructions to authors to make sure you do this
as required by the journal. One of the most tedious aspects of writing
for science is complying with the different styles used by different
journals both for how literature is referred to in the text and how the
papers are listed in the reference section.
next
next
next
Editing systematically
In this way, you edit the largest units of meaning in your text first.
Problems at the sentence and word level will tend to disappear as you
edit paragraphs; other problems at the word level will fall away as you
edit sentences. Editing systematically means that you get maximum
benefit for minimum effort.
next
Publishing
Responding to editors
Correcting proofs
Publishing
next
Publishing
next
Publishing
There are a range of comments that you could receive from the editor
and referees. Broadly, the response of the editor will be either that
your paper has been accepted for publication or not.
If the response from the editor is that your paper has not been
accepted for publication, there will usually be reasons given for the
decision. You should not lose faith, if that is the case. You need to
assess the reasons to see whether your paper might be accepted if
you made certain revisions.
next
Publishing
If the editor believes that the subject of your paper falls outside the
scope of the journal, you have no choice but to submit to another
journal. If the subject of your paper is not appropriate for publication
in that journal, it is not a comment on your capabilities.
next
Publishing
Importance of proof-reading
How to proof-read
Marks used
Guidelines
Checklist
Exercise
Publishing
Importance of proof-reading
Checking the proofs is your opportunity to make sure that your printed
paper is correct in every way.
next
Publishing
How to proof-read
● check the proof against copy, i.e. check every word and figure
against the original typescript
● read it through for sense.
next
Publishing
next
Publishing
Corrections have to be marked twice: once in the text and once in the
margin. If you only mark them in the text, the typesetter might not
see them.
Place the margin marks in the margin nearest to, and level with, the
mistake. For example, if the mistake is in the left half of the column of
text, insert your mark in the left margin, on the same line as the
mistake.
Draw a stroke (/) after each marginal mark so that it is clear that it is
concluded. It is particularly important to do this if there is more than
one correction in a line.
next
Publishing
● Look out for a word that has been changed for another. e.g. from
changed to form, or first changed to fist, or causal changed to
casual.
● Make sure that any figures or tables are in the right place and
that they have their correct headings or captions.
● Take particular care over checking scientific or technical terms.
● Take particular care over checking figures. You are the only
person who will know if they are wrong - until your peers spot
them in the published paper.
● Tables: make sure that all words and figures are in the correct
columns and that figures are correctly aligned.
next
Publishing
Exercise
Print it out and make corrections using the marks we provided on the
table earlier.
next
Publishing
next
Publishing
Most journals offer a reprint service - they will print off extra copies of
your paper for you, provided that you order them in advance (and pay
for them). If you have a list of potential recipients of your paper, you
will know how many reprints to order.
next