Re: Concept - Task ratio

Subject: Re: Concept - Task ratio
From: John Posada <jposada99 -at- gmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 3 Feb 2011 09:26:50 -0500

> However, let's not confuse WHY info (which IMO is always needed) with conceptual info that might be needed by very few users in John's particular case. Not giving the WHY is an insult to the user's intelligence. Did the user do something wrong or is it a temporary network problem? Can the user apply the steps if the problem occurs again in the future or the cause of the problem may be different each time?

Don't misunderstand me. I believe there should be a representation of
conceptual material. I agree that if you educate someone about how a
feature or device works, they will stay out of trouble and not need
problem resolution.

To our customers, there are three main categories of topics; features,
devices, and billing.

Our service has features, such as caller id. There is the device,
which, being voice over IP, connects their phone to their Internet
service, and there is paying their bill.

Take features. How many different articles do we need to describe
caller ID? It does what it does. Now, there may be 3, 4, or more
different things that they need to resolve by it doing something
unexpected, However, if I can give accurate information in the one
concept article on what it does and doesn't do, maybe I'll avoid
several issue by not having the customer try to do something it was
never intended to do in the first place.

My wish to have minimal conceptual articles, not minimal conceptual
content, which isn't driven so much by not wanting to tell them
everything, but should we have multiple conceptual articles, they read
one and miss what we told them in the others. It is by having multiple
articles that we are doing them a disservice.

This is all besides the simplification of maintenance of the content,
better See also linking, and more streamlined search engine hit

John Posada

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
Re: Concept - Task ratio: From: Mike Starr
Re: Concept - Task ratio: From: Gene Kim-Eng
Re: Concept - Task ratio: From: Mike Starr
Re: Concept - Task ratio: From: Gene Kim-Eng
Re: Concept - Task ratio: From: Mike Starr
RE: Concept - Task ratio: From: Erika Yanovich

Previous by Author: Re: Best Practice...Reuse Content
Next by Author: Customer-friendly word for "landline"
Previous by Thread: RE: Concept - Task ratio
Next by Thread: Truth in doc-vertizing?

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

Sponsored Ads