CA4 Project (CA400) Documentation Format

Title Page

  1. Title of the Project
  2. Name(s) of the Author(s)/Project Team with CAO numbers
  3. Name of Supervisor
  4. Date of submission
  5. The project code in the top right corner (fairly large - it helps when sorting them)

Title Page Example

Main Documentation

Documentation for the CA4 project should consist of

  1. A User manual
  2. A Techinical Manual
  3. An sample of your best code (30 pages max)

Note the 3 documents should be all bound together in a single volume using a plastic ring binder.

Only one copy of this volume should be submitted.

Some Guidlines

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.

 

0. Table of contents

A table of contents with pages numbers indicated for all sections / headings should be included.

1. Introduction

1.1 Overview
Provides a brief (half page) overview of the system / product that was developed. Include a description of how it works with other systems (if appropriate).

1.2 Glossary
Define and technical terms used in this document. Only include those with which the reader may not be familiar.

2. System Architecture

This section describes the high-level overview of the system architecture showing the distribution functions across (potential) system modules. Architectural components that are reused or 3rd party should be highlighted. Unlike the architecture in the Functional Specification - this description must reflect the design components of the system as it is demonstrated.

3. High-Level Design

This section should set out the high-level design of the system. It should include system models showing the relationship between system components and the systems and its environment. These might be object-models, DFD, etc. Unlike the design in the Functional Specification - this description must reflect the design of the system as it is demonstrated.

4. Problems and Resolution

This section should include a description of any major problems encountered during the design and implementation of the system and the actions that were taken to resolve them. (You might refer to your Blogs)

5. Installation Guide

This is a 1 to 2 page section which contains a step by step software installation guide. It should include a detailed description of the steps necessary to install the software, a list of all required software, components, versions, hardware, etc.

 

 

Always keep good (up to date) backups of documentation and software!