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:Cam Whetstone <camw -at- HOME -dot- COM> Date:Fri, 6 Nov 1998 07:48:35 -0500
ANON wrote:
I am writing a tutorial for a software product. I have written other
manuals and online documentation for the product, but this is the
first time I'm writing a tutorial.
My problem is that no one has given me any direction as to what the
tutorial should do. My initial impulse is to just to make up my own
sample project and walk users through creating that project using the
software. Of course, I won't be able to walk users through all the
features, so I'll probably just do those that are most commonly used.
Does anyone have any opinions or suggestions? If anyone knows of or
has written up a guide or plan for writing a tutorial, I will be very
grateful to find out.
Thanks.
---------
Your first task is to simply determine what you want to teach to who.
Once you have determined your overall objectives, try to break those
down into manageable chunks. Once you have chunks, you prepare a lesson
plan to teach the objectives. The breakdown into manageable chunks is
your course outline. Your next level are your lesson plans. You may
have some trouble determining the length of each lesson since you have
so little experience with training, but don't let it stop you. Tell
your supervisor that since it is your first shot, the timing may go over
or under until you have practice -taught the course once or twice.