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: Using scenarios in documentation? From:"Paul Strasser" <paul -dot- strasser -at- windsor-tech -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 3 Oct 2002 08:58:29 -0600
Generally, I use scenarios in tutorials rather than online help. But - come
to think of it - I'm starting to write a very large online help project this
week, and I've already used some sort of scenario in a couple of modules.
Whether it's truly high-level, medium-level, or way-too-low-level is
something I'll find out when our QA folks try their hand at my OL Help.
Some of these modules desperately need scenarios to prevent the average user
from floundering about in the various windows. In these cases the scenarios
use a combination of narrative, visio flowcharts, and screen captures to
show the user exactly how our software compares to the business function
they're trying to complete. So far they've gotten good reviews - one of the
chief programmers said it was very easy to read. Heh - high praise from an
SME.
If a scenario helps the user, then write it.
Paul Strasser
Windsor Technologies, Inc.
2569 Park Lane, Suite 200
Lafayette, Colorado 80026
Phone: 303-926-1982
FAX: 303-926-1510
E-mail: paul -dot- strasser -at- windsor-tech -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORINGTOOL for MS Word. SAVE $100 on the full version and $50 on upgrades.
Offer ends Oct 31, 02 (code: DTH102250). http://www.componentone.com/d2hlist1002
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
