RE: designing software tutorials

Subject: RE: designing software tutorials
From: "technical writing plus" <doc-x -at- earthlink -dot- net>
To: "'V. Camgros'" <camgros -at- mindspring -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 25 Jun 2007 16:09:15 -0600

There are quite a few worthy web resources, and books too, but I cannot tell
you what any of them might be, simply because I do not know.

However, I can say that you should start out by making a list that sets out
clearly the stuff that you *think at this time* the users should know.

Then use the list to start conversations with the people who know and use
the new software (or who will be developing it).

Then investigate those web resources. Then start on designing tutorials,
after you know what your needs are.

Jim Jones

-----Original Message-----
...list, though I read your discussion with interest and often respond to
individuals when I think I might have a contribution. Now I am faced with an
opportunity and would like your opinions on how to best respond to it.

I work for a small startup that makes Java developer tools. We've recently
re-designed the product and now my management wants new product tutorials
developed to match.

I know that the new tutorials must be modular, written to answer the needs
of the specific target audiences, and easy to understand. Beyond that, the
field is so completely wide open that it feels like my mind might explode.

And so my question to you: How would you go about planning this redesign?
What books, web sites, blogs, whathaveyou are essential to informing your
efforts when attempting to train your uses to be successful with your


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.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

designing software tutorials: From: V. Camgros

Previous by Author: RE: Medical Disabilty/Contracting/Jobs
Next by Author: RE: Employment question
Previous by Thread: designing software tutorials
Next by Thread: Re: designing software tutorials

What this post helpful? Share it with friends and colleagues:

Sponsored Ads