Tutorial-template-discussion
Contents
- 1 Tutorial - Training - Template Project
- 1.1 What are the benefits of printed tutorial/training materials?
- 1.2 What is the current training template?
- 1.3 What is the current User Manual template?
- 1.4 What kinds of things are not included in either?
- 1.5 What would a new template look like?
- 1.6 Case Studies of some existing documentation and training practices
Tutorial - Training - Template Project
This is a project to examine the current mix of caBIG Documentation and Training templates and find if there are useful kinds of information being left out, or if the means of organizing and presenting the material could be improved.
What are the benefits of printed tutorial/training materials?
1. The can serve as a record of a point in time, that is as a historical record of how things were done. 2. Fixed references to sections, figures and tables can be generated for reference in other documents.
What is the current training template?
The training development process is tailored to a specific audience and use of the material. How does the existing template deal with this?
What is the current User Manual template?
Introduction
- Organization
- Getting Started with the Software
Software Overview
- Overview
- Components
- Features and Functions
- Description of the User Interface
User Interface
- Description of major components
User Types and Workflows
- Use and or Workflow
- Repeat as many times as needed.
Error Messages/Problem Resultions
What kinds of things are not included in either?
Glossary etc
Appendix: References
===Appendix: Glossary (alternative location)
Testing of knowledge.
Short How-To sections??
Links to other media like PPT, Wiki's, PDFs and other docs....
Links to live developer Wiki pages which may contain up-to-the minute information, plans, reports.
Guided examples - how might these differ from ones in either current User Manual or Training Slides.
FAQ?
