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.
-----Original Message-----
From: Kevin McGowan
Sent: Tuesday, November 06, 2007 2:27 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: "Choose your own" install guide
>As I'm learning more and more complications about our product install
>process from the professional services people, I am now pondering
rewriting
>my install guide modelled on the old "choose your own adventure" books
from
>my childhood.
<snip>
>Is this madness? Will a reader be annoyed reading a 100-page document
set >up like this?
As I've seen it in practice (most recently, trying to tackle a horribly
unstructured and not very helpful troubleshooting procedure) it does
work best when you first approach it as a flow diagram, just to make
sure that is planned out and the structure it clear before you even try
to tackle the words that go along with it.
As long as the "jumps" to sections are clear, it's usually not that
difficult to use a guide like that.
Also, it's one of those things that when more information needs to be
added or there are new options in the process, you have to take the time
to map it all out again to make sure it is still workable (and it
doesn't become something like a horribly unstructured and not very
helpful troubleshooting procedure) and that everything is still in the
right place. Doing that with each addition keeps you from a massive
re-work when you finally step back from it, read it, and go "Huh?"
- Victoria
This e-mail may contain confidential or privileged information. If you think you have received this e-mail in error, please advise the sender by reply e-mail and then delete this e-mail immediately.
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-
