1 / 17

SETA EAST Conference

Join Janie Forrest-Glotzer from the SICAS Center to explore the creation and benefits of technical documentation, including functional specifications, solution specifications, and application manuals. This session will cover the types of technical information included in manuals, techniques for using Adobe Acrobat tools, and how to utilize documentation for training and problem-solving. Discover practical tips for customizing your documentation to meet the needs of various users, including novices and experienced professionals.

birch
Télécharger la présentation

SETA EAST Conference

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. 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 • If you must leave the session early, please do so as discretely as possible • Please avoid side conversation during the presentation Thank you for your cooperation!

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

  4. Benefits • 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 • Creating SICAS Technical Documentation • Functional & Solution Specifications • Application Manual • How Technical Information is Organized • Types of Users • Tips and Tricks for using Technical Documentation • Technical Documentation for End Users • Installing & Using the SICAS Software • Problem Solving • Training Purposes

  6. Functional Specifications • FDR (Future Direction Request) • FAUG (Functional Area User Group) • Focus Group Meeting – Feedback • Campus – Beta Test • 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 • Feedback From FAUG & Focus Group • Template • Programming & Testing • Code Review

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

  9. Application Manual • Standards for Documentation • 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 • Technical User • Experienced End User • Novice End User • The Content for User Manuals

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

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

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

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

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

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

  17. Thank You! Janie Forrest-Glotzer, SICAS Center forresjl@oneonta.edu Student Information & Campus Administrative Systems

More Related