Documentation

Standards

Supervisors may specify documentation standards and/or tools to be used in developing the project documentation. The following documentation standards are only a guide and may not be appropriate for all projects. Discuss with your supervisor what is required.

All documentation should be of a professional standard. The document must be produced using a word processor, modelling tool or other document generator that has been approved by your supervisor. All documentation must be devoid of spelling mistakes and grammatical errors. All printed documentation must be placed in A4 folders. If necessary computer pages may be folded.

The supervisor will keep a copy of your final documentation, so if you wish to have a copy with comments etc., then you should hand in two copies of your reports.

Submitted work must contain a Statement of Authorship, signed by all team members. See http://www.latrobe.edu.au/acadserv/staff/misconplagiarism.html

On-going Documentation

A weekly diary (blog) is to be provided to your supervisor throughout the project.

Other documentation will be produced throughout your project and may be brought with you to all scheduled project sessions and when you consult your supervisor at other times. You are required to maintain a working folder which forms the basis of the three standard manuals required in your final submission. Only one draft of each part of the documentation is to be kept in your working folder. This will make the process of producing final draft material for submission quick and easy.

Final Project Documentation

The documentation required depends on the type of project. Project types may be:

  • Systems Development Project
  • Software Development Project
  • Professional IT Work Experience incorporating a minor research project (Minor Project only)

Systems & Software Development Project Documentation

The standard manuals required at the end of your project are:

There is to be no unwarranted repetition within or between the manuals submitted at one time. One final quality copy of each of the three standard manuals is to be submitted each semester. Both sides of the paper may be used. The final report and manuals are normally retained by your supervisor. You are expected to make your own copy of all the work that you submit. Students involved in team projects will write individual project reports and common systems and user manuals.

Note that the lists of contents for the three standard manuals are for guidance only. Select as appropriate to your project after discussion with your supervisor.

Professional IT Work Experience

The Professional IT Work Experience documentation consists of two components

  • Work Experience Project report
  • Special Research Topic report

The format and layout of the Work Experience report is identical to that required for the Indvidual project report for the System and Software Development projects, however the content will differ depending on professional IT role you are assigned. You should write a comprehensive report of the business section or unit's operation and your experience in it, including:

  • The objectives of the business unit, its operating procedures and an analysis of its operation over the semester.
  • Your role and responsibilities in the business unit.
  • Why you chose your special research topic and how it relates to your role.

Referring to your diary entries and essay should help you to construct your report!


The Special Research Topic report should be written up as a correctly referenced research paper with the following sections:

  • Introduction and Background, (includingan explanation of howyour chosen topic related to your work position)
  • Methods, (i.e. how you went about your research)
  • Results and Discussion (i.e. what you learned and whether your views or perceptions have changed)
  • Conclusion (i.e. summarise your research outcomes)

Suggested size 3,000 words (approx.)

Staffing


Dr Sabine Wilkens
Pharmacy & Applied Science

Mary Martin
Computer Science
& Computer Engineering
La Trobe University, Bendigo

Notices

Welcome to the subject!