1

Project Documentation Template for student IT projects

Project Title: ___________________ Due Date: ___ / ___ / __

Completion Date: ___ / ___ / __

Project Summary:

Development Platform: ________________________

Developers:

Name Role
(1) _________________ ______________________
(2) _________________ ______________________
(3) _________________ ______________________
Items Responsible for
(1) _________________ ______________________, ______________________ , __________
(2) _________________ ______________________, ______________________ , __________
(3) _________________ ______________________, ______________________ , __________

Nathan Hutchings©2008
 2

Table of contents
1.0 Design ............................................................................................................................................................... 3
1.1 Problem definition .................................................................................................................................... 3
1.2 Solution specification ............................................................................................................................... 3
2.0 Develop............................................................................................................................................................. 5
2.1 Implementation ......................................................................................................................................... 5
2.2 Testing for errors ...................................................................................................................................... 5
3.0 Evaluate ............................................................................................................................................................ 6
3.0 Look back ................................................................................................................................................. 6
Appendix ................................................................................................................................................................ 6

Nathan Hutchings©2008
 3

1.0 Design
When required to solve a problem, the first thing that needs to be done is to define the problem itself. We must
be absolutely certain that the correct problem is being solved; otherwise the steps that follow may involve a lot
of wasted effort.

1.1 Problem definition

1.2 Solution specification

Then, after defining the problem, the next consideration is the steps which are required and the order in which
these steps must be performed. The technical term for this is an algorithm, a term which can be applied outside
the computing context as well as within. For example: a knitting patter, a recipe, doing long multiplication. In
the computer context planning a solution means developing an algorithm

Screen Design
Including any variable names for screen elements, note that there is no need to label the static text.

Nathan Hutchings©2008
 4

Nassi-Shneiderman (N-S) diagrams

Nathan Hutchings©2008
 5

2.0 Develop
For our purposes the develop stage means describing the algorithm in a language intelligible to a computer.
Such a description is called a program, and the language in which it is expressed is called a programming
language. There are literally hundreds of programming languages and a well written algorithm should be able
to be used by any of them to code a program. Once a program is written we then have to get the computer to
execute the program. During the implementation stage it is wise to clearly document the steps taken so that it is
easier to revise or improve at a later time.

2.1 Implementation
Variable names and types

Name Value Type Initial Value

Functions

Description (pseudo
Name Values required Values returned
code)

2.2 Testing for errors

User testing -

Nathan Hutchings©2008
 6

3.0 Evaluate
We first have to ensure that the process carried out in the last step corresponds to the task which was originally
defined, if this is not the case than all the previous steps have to be retraced. Once we are satisfied that the task
has been performed satisfactorily we may then go about looking for ways of improving the previous steps. And
so this cycle may be repeated several times before we are finally satisfied. In this context this cycle is referred
to as the software development cycle.

3.0 Look back

Appendix

Coding including internal documentation

//***********Declare Variables
var number_of_sides, dice, raw, the_result:Number;

//***********Declare Event Listeners

roll_btn.addEventListener(MouseEvent.CLICK, Response);

//***********Declare Event Listener Responses

function Response(evt:MouseEvent):void
{
rolldice(6); //number of sides is passed to rolldice function, set number of sides within ( )
number_text.text = dice;
raw_text.text = raw;
result_text.text = (String(the_result)); //need to cast the number to a string

//*********** Declare Functions

//function takes value for number of sides and returns rolled number
function rolldice(number_of_sides:int):int
{
raw = Math.random(); //random number less than 0
the_result = raw *number_of_sides; // positive number
dice = Math.ceil(the_result); // to the nearest whole number
return(dice);
}

Nathan Hutchings©2008
 7

Development Journal

Date Comment Problems / Recommendations

__ / __ / __

__ / __ / __

__ / __ / __

__ / __ / __

Nathan Hutchings©2008