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.
Jim Shaeffer wrote:
> How do you document step-by-step instructions for an ever-changing GUI?
> The strategy is that the independent presentation layer will
> allow our software to run anywhere and everywhere
> (desktops, laptops, tablet PCs, hand helds, PDAs, cell phones
> and devices that haven't been invented yet).
It's not likely that the same GUI will run on all those devices, so it's
also likely that each device will have different procedures.
It sounds like this is a top-down strategy delivered by someone who means
well, but doesn't completely understand the implications. Try a benchmarking
challenge: Make them show you examples of some other similar commercial
application that has extensive step-by-step procedures for every platform.
They probably won't be able to show you any examples, which indicates it is
too difficult, too expensive, and to unnecessary. If they do show you some
examples, drill into the examples and figure out how they did it.
> Horn 2: Our users need detailed, step-by-step instructions for
> every task they can perform while using our software. They complain
> that we don't give them enough step-by-step procedures, and they have
> amply demonstrated their need for them over the years. Further, it is
> obvious that there is no such thing as too much hand holding or too
> great a level of detail.
Sounds like they are trying to document their way out of some thorny design
problems. If the business need is that great, then invest in building
wizards. When you put it this way they may decide the business need isn't
really that great.
My preference is to document this type of application with a combination of
good architecture, good GUI design, and minimal online help.
NEED TO PUBLISH YOUR FRAMEMAKER CONTENT ONLINE?
?Mustang? (code name) is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to Web, intranets, and online Help.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! See a live demo that
will take your breath away: http://www.ehelp.com/techwr-l3
---
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.
