documentation n.
Skip this Video
Loading SlideShow in 5 Seconds..
Documentation PowerPoint Presentation
Download Presentation


121 Views Download Presentation
Download Presentation


- - - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - - -
Presentation Transcript

  1. Documentation

  2. Documentation • Some technical content may not be relevant to all projects as some students may tailor software packages as well as incorporate programming code and some may use programming code alone. • These decisions must be made by you as only you will truly understand your project. • However, you can use the documents in this slideshow as a template. • Also, you can add any other technical and relevantcontent in this document that you think will be necessary for your project. • Read Section 4.5 a 319 - 321 (Text)

  3. Sub-stages • System Maintenance Documentation (This document should describe how I created the solution) • User Guide (This printed document should describe how you use what I have created) • On Screen Help (This HTML document should describe how you use what I have created)

  4. System Maintenance Documentation • CIE Computing Syllabus, Page 39: • Read Section 4.5 a 319 - 320 (Text)

  5. System Maintenance Documentation • This technical manual is a standalone document. • You should think about the purpose of the document when you are writing it, which is to make it easy for someone who does not know the system to maintain and upgrade the system. It should encompass: • Table of Contents • Complete Requirements Section • Complete details of data structures used including records and files and the relationships between them. • Complete details about the data used and stored, including data types, data lengths, validation rules and design data stored • Clear definition and identification of purpose of subroutines and functions • DFDs describing the new solution • Annotated algorithms with pseudocode or flowcharts. • Annotated listing of code • Hardware and Software Specification • Details of at least one occurrence that demonstrates a need for “adaptive maintenance” .Read Section 4.5 a (Text) • You can add any other technical and relevantcontent in this document that you think will be necessry for your project.

  6. User Guide • CIE Computing Syllabus, Page 39:

  7. User Guide • CIE Computing Syllabus, Page 39: • Read Section 4.5 b 320 - 321 (Text)

  8. User Guide The documentation section is a separate section/booklet, but should be with the rest of the documentation. • Table of Contents • Introduction to the System • How to Install the System? • Details of input requirements including examples of valid and invalid data with explanations • Examples of the input screens so that the user knows that layout of the screens • Information on how to navigate between screens • Detail description of the Menu System • Details of output methods • Explanation of all error messages that may appear • Backup routines and data archiving strategies (if applicable) • Methods that have been used to protect the security of the data (e.g. passwords on files) • On-screen help facilities • A Troubleshooting Guide • The security of both the software and the data in use. • Guide to common errors • Glossary of Terms • Index

  9. Project Approval Form • This should be used after every stage. • However, you must list ALL the deliverables you created. • Failure to list all may result in obtaining a lower mark. • Also put in a Project Approval Form immediately after the deliverable where it is absolutely necessary to have client approval (such as the Design Objectives, Output Design and Input Design.