Re: Concept - Task ratio

Subject: Re: Concept - Task ratio
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: List, Techwriter <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 2 Feb 2011 08:07:18 -0800

Our default help format is based on task instructions, with a "How do I...?"
section upfront for the most common tasks. On models intended for "advanced"
users, there are "Learn more about.." links at the bottom of each task
instruction that jump to explanations of concepts and/or best practices for
special operations that require unusual combinations of tasks, such as how to
manually configure if you're trying to use the product with a system that its
auto-configure hasn't been designed to be compatible with. Most of these aren't
in the help at all, but are online.

Gene Kim-Eng

----- Original Message -----
From: "John Posada" <jposada99 -at- gmail -dot- com>
> For instance, I'm proposing the premise that since this is for a
> support site, we should be doing less explaining issues compared to
> more presenting procedures on how to do and fix things; the logic
> being that the average telephone customer doesn't care as much about
> how something works as they do with getting it to work so they can
> make their call and get on with their life.
> Keep in mind, I'm not writing for the techy geek, but for the average
> Joe Q Public with a telephone.


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.

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:


Concept - Task ratio: From: John Posada

Previous by Author: Re: Best Practice...Reuse Content
Next by Author: Re: Concept - Task ratio
Previous by Thread: Concept - Task ratio
Next by Thread: Re: Concept - Task ratio

What this post helpful? Share it with friends and colleagues:

Sponsored Ads