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: "Making the Most of Service Manuals" From:Fred Ridder <docudoc -at- hotmail -dot- com> To:Chris Borokowski <athloi -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 11 Apr 2008 11:05:36 -0400
Chris Borokowski wrote (in part):
> For the divergence in user groups, with some being experts and others
> being new, there are a number of strategies you can use when planning
> the documentation. One is to publish a "pocket guide" that's a
> telegraphic summary of common procedures, and variations. Another is to
> offer a "cookbook" to show common use cases to new users. One that I
> favor is to give new users a powerful introduction in the first
> chapter, and then offer "summaries" on each subsequent chapter which
> contain the short version of events the experts will want.
A variation on the third approach that can work well in the Service Manual
context is to present each procedure twice, first as a checklist with bare-
bones descriptions of each step, then in a detailed procedure where each
steps starts with the same description as the checklist so that it's clear
the two directly correspond. The technician can print out or photocopy
the checklist page and actually check off each step as it's completed,
whether or not they are reading the detailed instructions.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-