1 / 16

Documentation and Training

Documentation and Training. Types of Documentation. Systems documentation Internal documentation External documentation User documentation. Systems Documenation. Detailed information about a system’s design specifications, its internal workings and its functionality. Systems Documenation.

mayes
Download Presentation

Documentation and Training

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript


  1. Documentation and Training

  2. Types of Documentation • Systems documentation • Internal documentation • External documentation • User documentation

  3. Systems Documenation Detailed information about a system’s design specifications, its internal workings and its functionality

  4. Systems Documenation • The Design Project is an example of systems documenation • DFD • ERD • FHD/CRUD • Pseudocode/Process Design • Database Design • I/O Design • Also includes the Visual Basic Programs/Comments

  5. Two Types of Systems Documentation • Internal Documentation • External Documentation

  6. Internal Documentation System documentation that is part of the program source code or is generated at compile time

  7. Internal Documentation • Generally coded as comments in the source coding • Visual Basic comments • Descriptive variable names

  8. External Documentation System documentation that includes outcome of structured diagramming techniques such as data flow diagrams and entity relationship diagrams

  9. User Documentation Written or other visual information about an application system, how it works and how to use it

  10. User Documentation • User Manual • How to use the system • Explanation of error message • Definition of terms • Documentation of all functions • On-line Help

  11. Training and Supporting Users

  12. Support Providing ongoing educational and problem-solving assistance to information systems users

  13. Common Methods for Training • Tutorial • Course • Computer-aided instruction • Interactive training manuals • Resident expert • Software help • External sources of training

  14. Training Methods • Tutorial • Self-paced • Training one person at a time • Course • Training several people at one time • Pace of class may not be appropriate for each student

  15. Training Methods • CAI • Computer Aided Instruction • “The Video Professor” • Commonly on CD-ROM • Software moves the mouse for you to show you how to do it • Usually one person at a time • Interactive training manuals • CAI plus a manual • Allows the users to practice what they have been shown

  16. Training Methods • Resident Expert • An organizational employee who assists other users • Understands the organization and the software • Must common form of training (51%) • Software help components • Ex: Microsoft Word • User can ask a question or select from a table of contents • External sources • Many third-party organizations offer training (EIU for example) • Vendors/Software Designers generally offer some training as a selling feature

More Related