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.
> I have one more question. In your experience, did the manuals describe
> procedures (for example, importing a document) or features (for example, the
> Tools Menu)?
Procedures rather than features where there's a choice, but I'm not sure there's always a clear distinction, especially
when the procedure is feature based (such as configuring the software itself).
The product I was thinking of when I replied didn't have a GUI at all (it was a virtual machine programming
environment for building embedded systems software). However, where I *have* used this approach where there was
a GUI, such as in developing Interactive Electronic Technical Manuals, I think it's very hard to avoid referring to the
features (such as menus) when you want to describe tasks.
I think you are governed by two factors: the complexity of the software and the level of detail to which you want to
go. By this I mean that I have developed an inherent aversion to writing user manuals that explain every dialog box and
detail down to accurate detail and including screen shots at every step. I usually try to minimise the screen
dependencies where I can, otherwise the manuals are far too sensitive to (last minute) GUI changes, are a maintenance
nightmare, and have a tendency to patronise the user. Some users might want this approach (mine would be insulted)
so ymmv.
Simon North.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
---
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.
