Documentation Descriptions and  Guidelines

Project Proposal

Each project team must submit one project proposal to the CA326 coordinator Dr. Geoff Hamilton. A project proposal consists of 2 documents: a completed and a signed project proposal form and a project proposal description:

• Project proposal form may be downloaded here (PDF format only)
• Project proposal description - This is a complete description of the proposed project, which will be agreed with your supervisor. All proposal description must have the following 6 headings:
  1. Description - Minimum  250 word description of the proposed project.
  2. Programming language(s) - List the proposed language(s) to be used
  3. Programming tool(s) - List tools (compiler, database, web server, etc.) to be used
  4. Learning Challenges - List the main new things (technologies, languages, tools, etc) that you will have to learn
  5. Hardware / software platform - State the hardware and software platform for development, eg. PC, Linux, etc.
  6. Special hardware / software requirements - Describe any special requirements.
     • Note 1 - In general the School of Computing is not in a position to supply and support special hardware / software for 3rd years projects. Accordingly, any special needs should be provided by the students and discussed with your supervisor.
     • Note 2 - It is assumed that all projects will be developed / demonstrated using standard lab machines. Students may use their own hardware, but all project must be demonstrated in a School of Computing lab, either on a lab machine or the students own machine.

Functional Specification

A Functional Specification is a detailed technical description of the system to be developed. It includes a description of the problem to be addressed, a description of the proposed solution, a high-level description of system design (or potential design), an example operational scenario(s), and a preliminary schedule.

The process for creating and submitting the Functional Specification document is as follows: 

• Each project team must submit one Functional Specification document no later than 5pm Thursday 15/1/09.
• If you do not submit a functional specification by the deadline you will automatically receive a mark of 0 out of 10. There will be no exceptions to this.10% of the overall mark is allocated for this deliverable.
• All specification documents must be submitted via the project box in L114
  • A box is marked "CA326 Functional Specification"
  • You must complete the submission form with your Functional Specification

Contents of Functional Specification

The contents of each Functional Specification document will vary depending on the nature of the project. However, all projects Functional Specification's must contain the following information as a minimum. The specific format, layout and contents of each document is at the discretion of its authors.

Example Functional Specifications from last year's CA3 class

Below are some of the functional specifications from previous CA3 classes. Many thanks to those students for giving permission to post these here.

• Gerard Hill & Patrick Smith E-AlSAA
• Ian McSweeney & Aristides Garces A-Life
• Lorcan O'Maonaigh - 3D Graphics Rendering Framework
• Patrick O'Toole & Colin O'Driscoll Community

IEEE Example Templates

Some examples of SRS (Software Requirements Specification) based on the IEEE standard are:

• Example 1 Short version (MS Word)
• Example 2 Long version (MS Word)

User Manual

This is a 5 to 10 page user instruction guide on how to use the software system. It should include a step by step guide on how to use the product major components and should be written for a user and not technical audience (unless the system / product is intended for use by technical persons). You may consider including screen shots.

Technical Specification

This is an 8 to 12 page detailed design document, which reflects both the initial design and the current design, incorporating any major changes made after initial systems design. The contents of each Technical Specification document will vary depending on the nature of the project. However, all projects Technical Specification's must contain the following information as a minimum. The specific format, layout and contents of each document is at the discretion of its authors.