Rep WR: A Tchncalrep Made Easy
Rep WR: A Tchncalrep Made Easy
au
Rep
a
Wr
T chn cal Rep
Made Easy
C sult
Tim North, Scribe Consulting
www.scribe.com.au
www.scribe.com.au
Table
nts
iii
www.scribe.com.au
Capitalisation................................................................................................. 85
6.1 A quick anecdote about typography ..............................................................................86
6.2 Peoples names .................................................................................................................86
6.3 Government terms............................................................................................................87
6.4 Should I use full capitals? ................................................................................................88
6.5 Headings and titles ...........................................................................................................89
6.6 A list of times when we use a capital letter ....................................................................90
6.7 When not to use an initial capital ...................................................................................91
iv
www.scribe.com.au
1 Wr
r read
Rationale
Its far easier to inform or persuade your readers if you understand who they are, why
they want your report, what they already know, how much they want and when they
want it.
If you just guess at this information, youre likely to write for the wrong people, provide
the wrong information and/or pitch it at the wrong level.
It follows that its sensible to spend time researching your readers identities and needs
before you try writing for them.
Taking the trouble to write a good report, not just a mediocre one, generates benefits for
all parties: you, your readers, your organisation and your organisations clients.
Outcomes
You will be able to complete these tasks:
Explain the importance of identifying your readers and their needs.
Identify how much detail your readers need and will understand.
Interview readers in a style that encourages them to identify their needs.
Create a who-needs-what table to organise your writing.
Describe a strategy for providing information to diverse groups of readers with di erent
needs.
Describe a strategy for dealing with conflicting needs.
www.scribe.com.au
www.scribe.com.au
16
This manual discusses report writing. For more information on proposal writing, see Business Proposal
Writing Made Easy available here: www.scribe.com.au/ebooks.html.
www.scribe.com.au
So, how do you decide whether to write a report or a proposal? Ask yourself this question:
Who is the major beneficiary of this document: my readers or me?
If youre primarily seeking to altruistically serve the needs of your readers by answering
all of their questions, approach the task as a report.
If your writing starts by identifying your own needs (or that of your department, company etc.), approach it as a proposal.
Discussion
Does this distinction between reports and proposals seem reasonable?
Be sure to identify when the report is due. Adjust your timeline accordingly.
2.
3.
4.
5.
For each of them, identify how much they want from you.
6.
Identify if any of these needs are unachievable or are in conflict. If so, seek
agreement on a more achievable set of needs.
7.
Congratulate yourself! You now have a clear idea of who your report is for,
what each person or group needs, what level of language theyll understand
and how much they want. This is a great start to any report.0.
Done?
17
www.scribe.com.au
2 Why
te an
tl e?
Rationale
Without preparation, it is di icult to write a good report.
Without feedback early in the writing process, you may waste time and e ort.
Outcomes
You will be able to complete these tasks:
Explain why it is essential to prepare an outline (a table of contents) before proceeding.
Use your who-needs-what table to generate an outline.
19
www.scribe.com.au
would like the finance and engineering information centralised? If so, use the le -hand
structure.
Or are they project managers who would prefer to have all of the information about each
project together? If so, use the right-hand structure. Always let your readers needs guide
you.
www.scribe.com.au
3Wha
cluded?
Je nai fait celle-ci plus longue que parce que je nai pas eu le loisir de la faire plus courte.
have made this longer than usual because have not had time to make it shorter.)
Blaise Pascal, Lettres Provinciales 1857.
Rationale
Reports are expected to conform to certain structural conventions. If they dont, they
may be rejected by your readers and/or viewed as amateurish.
Conversely, reports that conform to peoples expectations are more likely to be described as professional and will be taken more seriously.
Outcomes
You will be able to complete these tasks:
Structure your report so that it includes commonly expected headings.
Include suitable and informative content under each heading.
Explain why the executive summary is vital to the success of your report.
Write an executive summary that conveys all the essential information and encourages
readers to read the rest of the report.
Write a background section that provides the necessary context for readers.
Write e ective conclusions and recommendations.
Decide what information should be confined to appendices.
Explain the importance of including references within your reports.
26
www.scribe.com.au
www.scribe.com.au
4 How d I pres
y ep t?
Rationale
Documents that are neatly and consistently formatted look professional and credible.
Documents that arent can appear amateurish.
Documents that appear amateurish may not be taken seriously even if they contain good
content.
There are accepted (if vague) conventions for formatting headings, captions and tables.
If youre unaware of these, your work can look amateurish.
Tables of information can be di icult to read if not formatted neatly. Conversely, neat
formatting can make the information presented in them more readable.
Outcomes
You will be able to complete these tasks:
Create suitable heading hierarchies.
Format headings in a credible and consistent style.
Choose a font that maximises legibility.
Choose and apply a line spacing that maximises the legibility of your work.
Explain why business email should be written professionally, not informally.
Correctly place and format captions.
Format tables in a neat style.
51
www.scribe.com.au
Introduction
7.2
Strengths
7.2.1 Weaknesses
7.3
Opportunities
7.4
Threats
55
www.scribe.com.au
ntial punctuati
should probably feed my sisters cats.
artifice401.blogspot.com/2009/06/importance-of-punctuation.html
Rationale
Properly used, punctuation can aid the clarity of what we write. Omitted, our writing can
be ambiguous.
There are accepted conventions for how to punctuate. If we are unaware of these, our
writing can look less professional.
In legal documents and technical specifications, poor punctuation can have serious
ramifications.
Outcomes
er completing this chapter, youll be able to:
Employ widely followed conventions for correct punctuation.
Use punctuation to avoid ambiguity.
Further reading
THE STYLE MANUAL FOR AUTHORS, EDITORS AND PRINTERS (6th edn, 2002), John Wiley and Sons.
66
www.scribe.com.au
18
Readers with a sound knowledge of grammar will note that the subject of the first sentence (underlined) is
di erent from the subject of the second.
67
www.scribe.com.au
Table 5.1:
Joining
words
Punctuation
Example
1. [none]
Sentence. Sentence.
2. [none]
Sentence; sentence.
3. accordingly
Sentence; [joining-word],
consequently sentence.
for example
furthermore
however
moreover
namely
nevertheless
otherwise
therefore
that is
thus
4. for
and
nor
but
or
yet
so
Sentence, [joining-word]
sentence.
5. because
as
if
then
Sentence [joining-word]
sentence.
Exercises
Punctuate these sentences:
1. I like this and would like to buy it.
2. I like this and I would like to buy it.
3. Johnson is a good team member but he may lack initiative.
4. Johnson is a good team member but lacks initiative.
5. Finish this work then meet me down at the bar.
6. I admire her because shes a hard worker.0.
77
www.scribe.com.au
Rationale
There are accepted conventions for when to use (and not to use) a capital letter at the
start of a word. If we are unaware of these, our writing can look less professional.
Contemporary usage employs fewer capital letters than in the past.
As the quotation above demonstrates, incorrect capitalisation can even change the
meaning of a sentence.
Outcomes
er completing this chapter, youll be able to:
Explain why it is unwise to overuse full capitals.
Choose a suitable style for capitalising headings and titles.
Identify when to use an initial capital letter and when not to.
Further reading
THE STYLE MANUAL FOR AUTHORS, EDITORS AND PRINTERS (6th edn, 2002), John Wiley and Sons.
85
www.scribe.com.au
Discussion
What are your preferences in this regard?
Does your organisation have a style sheet that specifies a capitalisation style to be
followed? If not, are you in a place to create such a style sheet? (Who is?)
89
www.scribe.com.au
7Sh
ned f
The good writing of any age has always been the product of someones neurosis, and wed have a
mighty dull literature if all the writers that came along were a bunch of happy chuckleheads.
William Styron, WRITERS AT WORK, 1958.
Rationale
There are accepted conventions for how to use abbreviations, contractions, acronyms
and symbols correctly. If we are unaware of these, our writing can look less professional.
The correct use of the metric system of units is the subject of much confusion.
The overuse of acronyms can lead to a loss of clarity.
Outcomes
er completing this chapter, youll be able to:
Distinguish between abbreviations, contractions, acronyms and symbols.
Know when to use capital letters and full stops in these shortened forms and when not
to.
Correctly write numbers and units using the metric system.
Employ strategies to prevent the overuse of acronyms.
Further reading
THE STYLE MANUAL FOR AUTHORS, EDITORS AND PRINTERS (6th edn, 2002), John Wiley and Sons.
93
www.scribe.com.au
8 Bu eted a
mb ed l ts
Rationale
Bulleted and numbered lists can be confusing if worded poorly.
There are accepted conventions for how to present bulleted and numbered lists. If we
are unaware of these, our writing can look less professional.
Outcomes
er completing this chapter, youll be able to:
Format bulleted and numbered lists for maximum clarity.
Punctuate bulleted and numbered lists correctly.
Employ what is known as parallel structure.
Decide when to use bullets and when to use numbers.
Further reading
THE STYLE MANUAL FOR AUTHORS, EDITORS AND PRINTERS (6th edn, 2002), John Wiley and Sons.
102
www.scribe.com.au
103
www.scribe.com.au
Downloadable b
om
C sult
The following e-books (PDF files) are also available for immediate download from Scribe
Consultings web site for just $12.95:
E DITING AND PROOFREADING
EDITING
AND
You put your credibility and reputation on the line every time you sit
down to write. In BUSINESS PROPOSAL WRITING MADE EASY youll discover how
to write proposals that not only succeed but which will build you a
reputation as a credible and trusted colleague.
ONLINE WRITING
ONLINE WRITING is an easy-to-follow manual aimed at anyone who
www.scribe.com.au
All of Scribes e-books come with a no-questions-asked, money-back guarantee.
106