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.
Connie Ross asked about writing a Training Manual for "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."
___________________________________________
Connie:
I agree with Peter's comments, too. For a template or samples I'd suggest
you go to Home Depot or Lowe's and pick up a few free leaflets that they
have for customers that want to install their own patios or decks. I would
not call the finished document a "Training Guide", even if that is the
boss's purpose. I'd call it an "Installation Guide". It would contain the
same information, large step-by-step pictures and instructions, and special
information for handling problem locations like uneven or swampy ground,
etc. The existing workers, new hires, and even contractors hired for an
unusual level of orders, would think nothing of using the company's
"Installation Guide", even if they'd be insulted at being handed a "Training
guide".
Margaret Cekis, Johns Creek GA
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-
