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: Training Manual? From:Gene Kim-Eng <techwr -at- genek -dot- com> To:Connie Ross <connie -at- hartiatech -dot- com> Date:Fri, 20 Jan 2012 08:42:50 -0800
In ISO Land, if the manual is an overview of how it's done it'd be a
process document and if it's detailed step-by-step directions it'd be a
work instruction. In this case, any name will probably work as long as the
subtitle and/or introductory front matter says something that imparts the
message "do it this way or you're fired."
As for examples, I have this from when I reclad my fireplace a few years
back.
It has some characteristics that make it a bit whacky for an amateur
installer, such as putting the list of required tools at the end rather
than the beginning, but I think it was actually intended for pros who carry
all these tools around all the time anyway.
Gene Kim-Eng
On Fri, Jan 20, 2012 at 1:36 AM, Connie Ross <connie -at- hartiatech -dot- com> wrote:
> Hi,
>
> I have a client who owns a Tennis Court and other sport surfacing
> business. He wants to document the steps required in laying down a tennis
> court surface from beginning to end, as a resource to train new staff. I
> am going to write it for him but I wanted to check with you all about what
> you would call such a document. My guess is that it's basically a training
> manual. It would include the steps required, Figures, calculations for
> mixing paints and other liquids as well as other items such as
> Troubleshooting, Glossary of Terms, Index, TOC, reference to further
> reading etc.
>
> Also, are there any good templates out there? I have written IT training
> manuals where there was a table, first column was the step number, followed
> in the next column with text instructions and then in the final column, the
> relevant figure.
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
