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: Tutorials From:TheLeener <TheLeener -at- AOL -dot- COM> Date:Thu, 11 Dec 1997 20:28:31 EST
I recently finished a large (well over 100 exercises) tutorial for a new
release of software.
I have one suggestion to add to the discusion. Begin each lesson (unit,
exercise, whatever) with clear objectives (at the end of this lesson, you will
be able to ...). Finish each lesson with some form of self test to confirm
that the objectives were met.
The system I was documenting was for maintenance facilities and covered a wide
range of functions. There were five distinct groups of users who would be
running the system for different purposes. Having objectives helped me to
stay focused on the tasks I had to teach, and not drift off on tangents about
all the different things a particular module could do.