Format and Style Guidelines
- Each report should have a Title Page containing the
it is a software project or a research project
name and email address
of your supervisor(s)
of the supervisor(s), indicating approval of the report
- Use headings for each section of the report.
- Include references where appropriate.
(Discuss the format for citing references with your supervisor. There are
many acceptable formats.)
- Consider using footnotes for factual references (but
do not over-footnote).
- It is often helpful to include a glossary of terms
and a list of abbreviations and acronyms.
- Incorporate figures and tables in the appropriate
point within the text of the document. Figures and tables should be referred
to within the text. If a figure is taken from an external source, give a
- Print single-sided on 8.5 by 11 inch paper.
- Number the pages.
- Do not use a font size smaller than 12 points for
the general text (although you may do so for footnotes, code, appendices,
- For the general text, use 1.5 spacing
between lines (although you may use single spacing for references and
indented long quotations).
- Use a spell checker.
- Check grammar, punctuation, apostrophes (e.g. it's
is the abbreviation for it
is, not a possessive pronoun!)
- The reports are formal documents, so avoid using abbreviations (other than
i.e., e.g., and etc.)
and abbreviations such as isn't for is
- Do not use jargon or slang expressions.
There are several books in the library that might help
with your written reports:
- Zobel, "Writing for Computer
- Dawson, "Projects in Computing and Information
Systems: A Student's Guide"