1. SETA EAST Conference SICAS Center Documentation Serving Clients through Technical Documentation Presenter: Janie Forrest-Glotzer, SICAS Center Tuesday, September 20, 2005 8:30am – 9:30am

2. Session Rules of Etiquette Please turn off your cell phone/beeper Please turn off your cell phone/beeper If you must leave the session early, please do so as discretely as possible If you must leave the session early, please do so as discretely as possible Please avoid side conversation during the presentation Please avoid side conversation during the presentation Thank you for your cooperation!

3. Introduction Creation of SICAS Technical Documentation Creation of SICAS Technical Documentation –Three Types of Documentation Functional Specifications Functional Specifications Solution Specifications Solution Specifications Application Manuals Application Manuals

4. Benefits Benefits of Attending this Session Benefits of Attending this Session –What types of Technical information is included in Application Manual –Creating Application Manuals for end users –How to use Adobe Acrobat Tools to create Application Manuals –Using Technical Documentation for Training Purposes

5. Topics of Discussion Agenda Agenda Creating SICAS Technical Documentation Creating SICAS Technical Documentation –Functional & Solution Specifications –Application Manual How Technical Information is Organized How Technical Information is Organized Types of Users Types of Users Tips and Tricks for using Technical Documentation Tips and Tricks for using Technical Documentation –Technical Documentation for End Users Installing & Using the SICAS Software Installing & Using the SICAS Software Problem Solving Problem Solving Training Purposes Training Purposes

6. Functional Specifications FDR (Future Direction Request) FDR (Future Direction Request) FAUG (Functional Area User Group) FAUG (Functional Area User Group) –Focus Group Meeting – Feedback –Campus – Beta Test Create the Framework for the FDR Create the Framework for the FDR –Example: Template –Planning & Project Management –Analysis/Design Stage for the Programmer

7. Solution Specifications Create the structure for the FDR Create the structure for the FDR Feedback From FAUG & Focus Group Feedback From FAUG & Focus Group Template Template Programming & Testing Programming & Testing Code Review Code Review

8. Application Manual Documentation Template Documentation Template –Cover Page –Confidential Business Information –Table of Contents –General Plain Page –Header and Footer Styles for Keywords Styles for Keywords –Programs – ALL CAPS, BOLD –Forms – ALL CAPS, BOLD, ITALICS –Table Names – ALL CAPS

9. Application Manual Standards for Documentation Standards for Documentation Each Manual Contains: Each Manual Contains: –Introduction –Description/Overview of Manual –Set Up Requirements –How To Run the Process –Sample Output from the Process –Parameter Description –List of Tables –Appendix

10. Application Manual The Target Audience The Target Audience –Technical User –Experienced End User –Novice End User The Content for User Manuals The Content for User Manuals

11. Tips and Tricks Creating a Table of Contents Creating a Table of Contents –PDF –Bookmarks Banner Screenshots – Snapshot Banner Screenshots – Snapshot Functional Flowchart Functional Flowchart Sample Reports Sample Reports

12. Tools for Accessing Documentation SICAS Center Web Site SICAS Center Web Site http://sicas.suny.edu SICAS Center Weekly Newsletter SICAS Center Weekly Newsletter

13. Using Technical Documentation for Training Purposes & Problem Solving Training Training –New Campus Training on Site –Training at the SICAS Center –Online Training with Horizon Wimba Problem Solving Problem Solving –Campus Support with Technical Documentation

14. Summary Format to Create Application Manual for end users Format to Create Application Manual for end users Types of Technical Information to include in Application Manual Types of Technical Information to include in Application Manual Ways to Use Technical Documentation For Training Purposes and Campus Support Ways to Use Technical Documentation For Training Purposes and Campus Support

15. Questions and Answers Questions/Comments Questions/Comments Discussion Time Discussion Time

16. Presenter Information Janie Forrest-Glotzer Janie Forrest-Glotzer SICAS Center SICAS Center Lee Hall SUNY Oneonta Campus Oneonta, NY 13820-4015 (607)-436-2029 (607)-436-2029 Email: forresjl@oneonta.edu Email: forresjl@oneonta.eduforresjl@oneonta.edu http://sicas.suny.edu http://sicas.suny.edu

17. Thank You! Janie Forrest-Glotzer, SICAS Center forresjl@oneonta.edu S tudent I nformation & C ampus A dministrative S ystems