CIS 4952/4962 Final Project Documentation

Fall 2007

 

     For your final task this semester, your team needs to build the project documentation. This document is to include the following non-trivial components (refer to your earlier assignments for details of each):

 

Cover Page

 

Acknowledgments

 

Table of Contents

 

Introduction/Overview

 

Requirements/Analysis Model

 

Hardware/Software Design

 

Implementation Details

 

Testing/SQA

 

Future Maintenance Suggestions

 

Delivery/Acceptance Statement

 

References & Bibliography

 

Appendix A - User Manual

 

Appendix B - Program Listing,

             Sample Output,

             Diskette

 

Appendix C - Team Member

             Resumes

 

Appendix D - Project Plan &

             Log Book

 

Appendix E - Project Demo

             Notes

 

Appendix F - Final 

             Presentation

             Slides

Appendix A - User Manual

         (detail)

 

Introduction

  Purpose of product

  operating environment

  general functionality

  special features

  limitations

  documentation conventions

 

Installation

  Physical requirements

  Copying & backup

  software installation

  customizing product

 

Tutorial

  Walkthrough of example

  Explanation of example

  Using help (on-line & text)

 

Detailed Instruction

  Output from product

  input to product

  operation of product

  error handling

  specific functions

    how to run

    input data needed

    output interpretation

 

Technical Details

  Principles of operation

  Advanced features

  Modification of product

  Support information

 

     Your team will be expected to do 15 to 20 minute demonstration of your project during our final exam period on December 5th. You will need to turn in a CD containing your final report, all source code and executables, copies of your draft documents, all powerpoint slides, individual postmortem reports using form from web page, and a completed senior design template using the form from the web page. 

 

 

Date assigned: 10/31/07

Date due:      12/05/07