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'm not saying grandma should have to plow through the concepts in order to get to the procedure. I'm talking about something similar to what Gene outlined... make the concepts available as related topics. Just don't omit them completely as some companies are doing.
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Technical Illustrator
Graphic Designer - Desktop Publisher - MS Office Expert
(262) 694-1028 - mike -at- writestarr -dot- com - http://www.writestarr.com
On 2/2/2011 12:03 PM, John Posada wrote:
>>> Many companies are adopting the Tivo model that Laura reported
>>> and I feel that's a big disservice to users. If we help them
>>> understand the the why, they'll have an easier time dealing with the how.
> That works in the area of software documentation to professionals in
> the tech field, the kind that we are used to dealing with.
> However, picture your grandmother. She has a phone and the audio sound
> is poor...her granschild sounds garbled when she calls to say hello on
> Sunday afternoon.
> Does she want to read stuff that includes, but is not limited to:
> "Noise interference only affects analog waves; therefore static or
> garbled audio can occur wherever analog waves are used in the system.
> To reduce this possibility, the only section of the telephone system
> that will use analog waves is from the phone port on the device to the
> telephone handset. No matter what setup you have, the signal has to
> get translated to analog waves at some point, or else you wound not be
> able to understand the sound coming out of the phone. "
> or does she want to read
> Step 1 ...
> Step 2 ..
> Step 3 ..
> We aren't adopting it because it's cheaper...on the contrary,
> conceptual material is cheaper to write than procedures.
> We're adopting it because we read several hundred comments per week
> from customers through article feedback and this is what they are
> telling us they want.
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-