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.
Lisa H wrote:
>Are you really comfortable telling users what to "enter" without
>at why you have requested that action? In my experience, "why" is
>equally important as the "how" because whys foster learning by
>comprehension and instead of by rote.
I think you're right about the importance of "whys" but I'd put them in an introductory paragraph rather than within operating instructions. IMO, wordy explanations distract users from the actual procedure flow. I guess that those who want to perform the procedure, know why they do this. They just don't know how. If they know neither why nor how, they can read the entire section from the beginning and get the explanations before getting to the instructions.
Ahhh...imagining that irresistible "new car" smell?
Check outnew cars at Yahoo! Autos.
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. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-