Report Writing 2008 Edition - Standard
Report Writing 2008 Edition - Standard
FOR
MCPM & MPD STUDENTS
BY
MICHAEL C. BRAND
2008 Edition
Editors:
Dr. George Earl
Dr. Thomas Uher
Dr. Goran Runeson
The following is a brief discussion of each element listed above (see Appendix).
For the purposes of assignment work at university, the title page need not be
elaborate. Colourful graphics, fancy paper and catchy titles are of no consequence.
Lecturers are only interested in what you have written. Therefore, you are better
advised to spend the time on the substance of the report rather than on its title page.
So long as the title page is neat, clear and contains the information required, it will be
considered quite acceptable.
It is best to generate the TOC using the ‘style’ and ‘table’ functions, which are
available on many word processing software applications, such as MS Word.
The abstract is a condensed version of the full report. The abstract should be brief
and informative. Tell the reader what the report is about, how it was undertaken, and
what was discovered.
Conventionally, the abstract should NOT exceed 130 words for a report of, say, 5,000
words or less, and must be written as one paragraph.
1.6.2 Contents
The contents of the report must be relevant to your investigation i.e., must present and
describe and all essential information in a balanced and logical style, with a view of
coming to some plausible conclusion(s) and recommendation(s).
You must support your argument(s) and opinions with credible evidence so you must
carefully consider which sources of information that you choose to include in your
research. Recent academic journal and conference papers, as well as recent
textbooks, are the most credible sources of information. Newspaper columns and
magazine articles are the least credible sources of information.
1.6.3 Language
The most important thing to remember when writing a report is that it must be clear
and logical to the reader; the reader must understand the report.
At university, you should assume that you are writing for a ‘non-technical’ reader
(Beisler et. al. 1993). Therefore, the language must be kept simple. Jargon should be
avoided. If jargon is unavoidable then it must be explained adequately.
No new materials or ideas must be introduced into the conclusion. Your conclusion
must be based on evidence presented in the body of the report.
The conclusion will serve as a platform for the writer’s recommendation(s) so it must
be adequate to support such recommendations.
Importantly, it should not contain any material that might be considered defamatory
or vexatious.
If an appendix is included then it must be referred to in the body of the report at the
appropriate location in the text. At the end of the sentence were you want to refer to
the appendix you would add: ‘(see Appendix)’. If there is more than one appendix,
you must give each appendix an alphabetical identifier i.e., ‘Appendix A’, ‘Appendix
B’, ‘Appendix C’…etc. You must place the appendices in alphabetical order at the
end of the report so that the reader can easily locate them.
As a general rule, writers should avoid using an appendix. Since appendices are often
incorrectly used by novice report writers, who usually render them nothing more than
Students will adopt the parenthetical system of in-text referencing. Examples of this
system are given below.
End of sentence
One author
Two authors
Author’s Year of
surname publication
Two authors
Author’s Year of
surname publication
Three or more authors (second and subsequent times you refer to their
publication)
Note: Put publications in order starting with most recent year of publication.
Method 2
Both must be introduced and clearly explained to the reader in the text;
Both must be relevant to your discussion;
Figures must not be too small and must be legible;
Tables must be as brief and concise as possible; and
Both must be correctly labeled and referenced.
The following examples briefly demonstrate the correct use and labeling of
figures and tables on the body of a report.
When labeling figures using the decimal method, the first digit signifies the
chapter/section number where the figure appears. The second digit signifies its
position in the chapter/section. Therefore, the figure number ‘3.1’ (as shown
below) means that this figure is in chapter ‘3’ and is the first (‘1’) figure in the
chapter. The second figure in chapter 3 would be labeled ‘Figure 3.2’. The third
figure in chapter 3 would be labeled ‘Figure 3.3’…and so on. (Note that if there
is only one figure in chapter 3 it would be labeled simply ‘Figure 3’ - there is no
need to differentiate it any further).
The simple model illustrated in Figure 3.1 above shows that by using
various forms of telecommunications…
When labeling tables using the decimal method, the first digit signifies the
chapter/section number where the table appears. The second digit signifies its
position in the chapter/section. Therefore, the table number ‘3.1’ (as shown
below) means that this table is in chapter ‘3’ and is the first (‘1’) table in the
chapter. The second table in chapter 3 would be labeled ‘Table 3.2’. The third
figure in chapter 3 would be labeled ‘Table 3.3’…and so on. (Note that if there is
only one table in chapter 3 it would be labeled simply ‘Table 3’ - there is no need
to differentiate it any further).
Table 3.1 above shows that there are a variety of opportunities available
to the AEC industry to…
Note that the in-text referencing for short quotes adds the page number of the
original text where the quote was extracted.
You may use either single (‘…’) or double (“…”) quotation marks for short
quotes, but you must use one consistently throughout the report.
Also note the use of 3 stops (…). This is used to indicate that words are missing
from the quote. Avoid or avoid overuse in a single quote.
Finally never end a paragraph with a quote. You must explain or justify its
inclusion into the report to the reader.
Page number
Note that the in-text referencing for long quotes adds the page number of the
original text where the quote was extracted.
Quotation marks are not used for long quotes. Font size of quote remains the
same as body text.
Year of Name of
Author publication Title of book (italic) Edition publisher
Smith, J., (2004) A day in the life of a project manager, 2nd ed., Building
Book Co., Sydney, p. 16.
c. Conference papers
One author
Year of Title of paper Name of conference
Author publication (in quotation marks) (in italic)
d. Government report/publication
One author/issuing body
Year of Title of report
Author/issuing body publication (in italic)
e. Media/press release
One author
Year of Title of release
Author/issuing body release (italic)
Smith J., (2001) ‘Trade unions turn up the heat’, Sydney Morning Herald,
15 July, p. 4.
Date of Page cited
publication
g. Parliamentary debate
One speaker
Year of House of
Speaker debate Jurisdiction Parliament
h. Public address/speech
One speaker
Year of Title of
Speaker speech speech
i. Private interview
One interviewee
Do not compromise the interviewee; always seek the permission of the
interviewee if you wish to use all or any part of the interview.
Name of Year of Position of
interviewee interview interviewee Topic of interview
Smith J., (2003) CEO Brax Corporation, Private interview, ‘The delivery
of D&C projects’, Sydney, 19 October.
Place of interview Date of interview
k. Case law
Reported cases
AND
Name of case Name of law report
(in italic) Page cited
Unreported cases
Name of case
(in italic) Judges
l. Legislation
Bills for an Act
Name of Act
(in italic) Jurisdiction
m. Internet
The Internet is a rich source of information if used correctly. Many private and
public institutions including law firms, government departments and researchers
allow access to a variety of publications in electronic form. It is crucial that
students are able to correctly cite electronic publications in addition to being able
to correctly cite the equivalent hard-copy.
1. The precise web address of the document (simply providing the home page
web address is NOT acceptable); and
2. The date that the electronic document was accessed by the author.
n. Private email
Do not compromise the person that has sent the email; always seek the
permission of the sender if you wish to use all or any part of their email.
Name of Year of Position of
sender sender sender Title/subject
Smith J., (2004) CEO of Brax Corporation, Private email, ‘The delivery of
BOOT projects’, 12 July.
Transmission date
Again, do not compromise the person that has posted the information; always
seek the permission of the author if you wish to use all or any part of their
posted material.
Name of
sender Year posted Position of sender Title/subject
Smith J., (2002) Partner at Biggs & Assoc, ‘The future of international
arbitration in Australia’, 12 July, <[email protected]> (19 July).
Date posted/broadcast Name of newsgroup Date accessed
p. CD-ROM
There is a great deal of information that is stored electronically on CD-ROM,
such as: conference proceedings, encyclopedias, the Building Code of
Australia, legal material…etc.
Citing material obtained on CD-ROM follows the same method as for hard-
copy material, except the citation must identify the storage medium. The
following is example of how to an author should cite a conference proceeding
located on CD-ROM.
If an author uses the work of another, and intentionally or mistakenly passes off the
work as their own, a charge of plagiarism is justified.
Beisler F., Scheeres H. & Pinner D., (1993), 2nd ed., Communications Skills,
Longman Cheshire, Melbourne, pp. 162-69.
Runeson G. & Skitmore M., (1999) Writing Research Reports, UNSW Press, Sydney.
Stuhmcke A., (2001) Legal Referencing, 2nd ed., Butterworths., Australia, pp. 8, 20,
37, 63.
Walliaman N., (2001) Your research project – a step-by-step guide for the first-time
researcher, SAGE Publications, London.
Title of report
Due date
Abstract Appropriate length (100-130 words for reports under 5000 words)
Single paragraph
Summary of report:
- purpose
- major findings
Long and short quotations correctly formatted and acknowledged in the text.
Conclusion Arising out of the Body of the report only (no new information is to be
introduced)
Write in the light of the aims and objectives set out in the Introduction
Alphabetical order
Appendix Label ‘Appendix’. If more than one, then label as: ‘Appendix A’, ‘B’,
‘C’…etc.
Do not add an Appendix unless:
it is referred to in the Body of the report.
serves to some real purpose.
Avoid.