System Documentation and User Manuals

1
System Documentation and User Manuals

• By Laura Ignat, Marta Wach,
• Kapil Gandhi

2
Required Documentation
3
Required Documentation contd
4
Inception

• Project Charter
• represents the first blue print of the system.
  It is a statement of intent by the user of their
  desire to develop the software solution.
• Team Charter (optional)
• should specify a minimum of four or five ways
  the group will ensure that it operates as
  efficiently as possible. This should also specify
  how conflict should be handled

5
Analysis

• Use Case Diagrams and Descriptions
• a use case illustrates activities that are
  performed by users of the system.
• Class Diagram
• represent things ideas and concepts
• templates for creating objects
• Sequence Diagram
• illustrate the objects that participate in a use
  case and show the messages that pass between
  objects for a particular use case

6
Design

• Class Diagram
• see above slide (includes Parameters)
• Screen Prototypes
• is the process of building a model of a system
• Report Designs
• building a model of a report
• Navigation Diagram
• shows the flow of the system
• flow between forms

7
Design contd

• Entity Relationship Diagram (ERD)
• shows the relationship between database tables
• Data Dictionary
• documentation of tables

8
Implementation

• Code Library
• documentation of the code
• Unit Test Plans Results
• discussed in another presentation
• On Line Help
• help online
• Tutorial
• teaching users the use of system

9
Implementation contd

• Deployment Guide
• discussed in another presentation
• Identification Sheet
• http//www.conestogac.on.ca/rkozak/

10
Project Management (Appendix)

• Meeting Agendas
• what you plan to achieve during meetings
• Meeting Minutes
• what you achieved during meetings
• Status Report
• report of current achievements
• Project Plan
• what you plan to achieve for the project

11
Demo Day

• Application Brochure
• summary of system
• Business Cards
• self explanatory
• Resumes
• your resumes
• Booth Display (handed in separately)
• set up of booth