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.
IMHO, depends on your goal. If the quick start's purpose is to install the
product, for example, or set up for first use, then you need it in paper
format. Or if your users are using basic computers or terminals, then you're
limited to the technology you can use.
To orient users to a product and shorten the learning curve, I like
multimedia quick tours (or previews). I love Quicken's (Deluxe 99). They put
a lot of thought into theirs (I think they call them overviews). For me,
quick tours are the first step in the learning process, and when done right,
they're interesting and very informative (effective and efficient, I guess
you could say).
My company likes to include a quick start guide with each
new software
update. The guides run ten to fifteen pages for each update
and are created
directly from the help file.
I wouldn't consider a fifteen page (including screen shots)
document "quick"
to read. Most of the information applies to novice users.
I don't have
much experience creating documentation; however, I believe
the guide should
be short and to the point without a screen shot for each
interface.
What is your experience with quick start guides? What about
using a
PowerPoint presentation? How can I improve upon the guide?
