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:Tutorials From:Damien Braniff <Damien_Braniff -at- PAC -dot- CO -dot- UK> Date:Mon, 8 Dec 1997 13:57:09 +0000
I thought I'd cracked my problem with searching the archives by going the
indirect route. Managed to search but it fell over when I tried to look at
the results of the search and so to my query!
I'm doing a distance learning MA in Tech Authorship and am about to finish
the diploma year - doing my last assignment which is to produce a tutorial
for a piece of software that currently lacks one. My question is:
Is there any recognised structure for tutorials? I've written training
material before but never specifically a tutorial (or at least nothing that
was called a tutorial!). The software I'm doing the tutorial for is the
admin software for one of our access control systems. What I have done so
Set the background and parameters - who it's aimed at etc - plus stating
any asssumptions I have made - PC literate etc. I know these are a bit
artifical but there is a word limit!
Introduction - What is access control and what is covered by the
tutorial - how to log in, add keys etc.
List of terminology which is specific to access control.
Example system - define example system (small office with 5 rooms) and
define doors, areas etc.
Describe each procedure covered with suitable diagrams/screenshots.
Screenshots include "blanks" and then the same screen with data entered.
In some ways it seems OK to me but part of me sees it as just an elaborate
(slightly noddy) set of "how to" instructions but then perhaps that's all a