FIT1046 Creative Computing Foundations Monash University Faculty of IT
FIT1046 CREATIVE COMPUTING FOUNDATIONS Documentation Guide
Supporting documentation is an important part for many IT projects, providing colleagues, clients and assessors a behind the scenes look of how the final product came to completion. The documentation component of the FIT1046 assignments provide you the opportunity to showcase your planning, decisions, problems, solutions and your workflow. If you are unsure how to go about doing effective documentation for your assignment here are several guiding points to help you along.
Documentation Tips:
Straight to the point
Documentation does not need to be overly long or thorough. Try to summarise the key aspects and milestones of the project and convey as much information as you can in as few words as possible. More is not always better.
If at first you dont succeed, try, try again
It is very unlikely you will pull off your first attempts in any project. The early phase of planning should always involve some experimentation, failure and redoes. This is all part of the process and should be documented along with what went wrong and possibly how it could be improved.
A picture is worth a thousand words
You do not always need to be overly wordy to get your point across. Consider using a simple labelled screenshot to show what you are trying to convey with a brief paragraph underneath the image. If the computer you are using has Windows consider using the Snipping Tool for taking cropped screenshots of your work.
Dont leave out anything important.
The FIT1046 assignments can generally be broken down into several phases, such as research, concept design, development and refinement Try not to over emphasise one phase of the project at the expense of another. Refer to the workflow demonstrated in the Week 1 Guide as a helpful illustration of how to organise your documentation.
Formatting and readability
One final important point along with the actual content is how clear and easily read your documentation is. Go through it yourself and ask, is it formatted well and is the information presented clearly? Is the story easy to follow? Consider researching how other documents are formatted as a guide.