TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: ANON: Writing a Tutorial From:"Molly M. Theodossy" <mmtheodossy -at- UCDAVIS -dot- EDU> Date:Fri, 6 Nov 1998 08:59:01 -0800
In the tutorials I have developed in the past, we took the approach of
developing a list of tasks or scenarios the users would have to commonly
complete in their day to day work. We would then describe the steps in
order to complete the scenario that was described at the top of the page.
The hardest part of these manuals was developing scenarios that were
realistic and useful to the users.
Our tutorial manuals were not meant to replace training. They were
developed as quick reference guides for a user who had already been through
some sort of formal training on the software. Therefore, this method worked
well for these manuals. If your tutorials are meant as a replacement for
training manuals, you will probably need to include more description of
functions than this approach involves.
*****************************************************************
Molly M. Theodossy
Technology Trainer/Technical Writer
mmtheodossy -at- ucdavis -dot- edu
(530) 754-2113
University of California, Davis
