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.
Subject:Re: Concept - Task ratio From:kafkascampi <kafkascampi -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 2 Feb 2011 09:54:54 -0800
Mike said: "I wouldn't put it in terms of a ratio... if it needs explaining,
it needs explaining."
Our ratio is probably around 5 tasks : 1 concept, but I agree with Mike that
concepts should be need-driven as opposed to required. I've always found
that if you need a paragraph to explain something within a task, that's
where you need a concept.
Chris Vickery
On Wed, Feb 2, 2011 at 9:28 AM, Mike Starr <mike -at- writestarr -dot- com> wrote:
> I wouldn't put it in terms of a ratio... if it needs explaining, it needs
> explaining. 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.
>
> --
> 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 9:47 AM, John Posada wrote:
> > Hi, guys...As I've said, I've been doing an analysis of our customer
> > support knowledgebase to look for areas of improvement.
> >
> > I've introduced the concept modeled after the DITA methodology of
> > Concept/Task/Reference and it has caught on strong.
> >
> > My question...for online help or web based help for consumer-type
> > services, specifically phone service, if you have thought about it, do
> > you find that you found a ratio of concept to task that worked out
> > best for you?
> >
> > 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.
> >
> > Has anyone else thought about this and if so, know of any best
> > practices that supports this premise?
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 kafkascampi -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/kafkascampi%40gmail.com
>
>
> 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
>http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-