Difference between revisions of "Tutorial-template-discussion"

(→‎What kinds of things are not included in either?)
(→‎Appendix: References)
 
(6 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
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.
 
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 is the current training template?==
+
==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 Hands-On 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?
 
The training development process is tailored to a specific audience and use of the material.  How does the existing template deal with this?
 +
 +
===Session Details===
 +
# Topic
 +
# Target Audience
 +
# Prerequisites
 +
 +
===Overview of the Training Environment===
 +
 +
 +
===Session Goals===
 +
 +
===Lesson Plan===
 +
 +
Lesson 1:
 +
 +
Lesson 2:
 +
 +
Lesson 3:
 +
 +
===Lesson 1: Introduction===
 +
====Lesson Overview====
 +
====Objectives/Content Slides====
 +
(Examples are:)
 +
# Demonstration of Action
 +
# Knowledge Checks (repetition and application)
 +
# Hands-On Exercises
 +
# Common Pitfalls
 +
# Tips and Tricks
 +
 +
====Review and Questions====
 +
# Repeat topic and objectives
 +
# include time for questions
 +
#
 +
 +
===Repeat for each lesson===
 +
 +
===Review of Entire Session===
 +
 +
 +
===Questions/Tests of Knowledge===
 +
 +
===Follow on Training===
 +
# what additional training materials are available.
 +
 +
 +
 +
 +
 +
  
 
==What is the current User Manual template?==
 
==What is the current User Manual template?==
  
−
==What kinds of things are not included in either?==
+
===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===
 +
 
 +
===Glossary etc===
 +
 
 +
===Appendix: References===
 +
 
 +
===Appendix: Glossary (alternative location)===
 +
 
 +
==What kinds of things are not currently included in either template?==
  
 
Testing of knowledge.
 
Testing of knowledge.
Line 15: Line 97:
  
 
Links to other media like PPT, Wiki's, PDFs and other docs....
 
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?
 
FAQ?
  
 
==What would a new template look like?==
 
==What would a new template look like?==
 +
 +
 +
==Case Studies of some existing documentation and training practices==
 +
 +
===caGrid===
 +
 +
 +
===GenePattern===
 +
 +
 +
===geWorkbench===

Latest revision as of 17:05, 14 June 2007

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 Hands-On 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?

Session Details

  1. Topic
  2. Target Audience
  3. Prerequisites

Overview of the Training Environment

Session Goals

Lesson Plan

Lesson 1:

Lesson 2:

Lesson 3:

Lesson 1: Introduction

Lesson Overview

Objectives/Content Slides

(Examples are:)

  1. Demonstration of Action
  2. Knowledge Checks (repetition and application)
  3. Hands-On Exercises
  4. Common Pitfalls
  5. Tips and Tricks

Review and Questions

  1. Repeat topic and objectives
  2. include time for questions

Repeat for each lesson

Review of Entire Session

Questions/Tests of Knowledge

Follow on Training

  1. what additional training materials are available.




What is the current User Manual template?

Introduction

  1. Organization
  2. Getting Started with the Software


Software Overview

  1. Overview
  2. Components
  3. Features and Functions
  4. Description of the User Interface

User Interface

  1. Description of major components

User Types and Workflows

  1. Use and or Workflow
  2. Repeat as many times as needed.


Error Messages/Problem Resultions

Glossary etc

Appendix: References

Appendix: Glossary (alternative location)

What kinds of things are not currently included in either template?

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?

What would a new template look like?

Case Studies of some existing documentation and training practices

caGrid

GenePattern

geWorkbench

Retrieved from "http://wiki.c2b2.columbia.edu/workbench/index.php?title=Tutorial-template-discussion&oldid=4051"