Re: Concept - Task ratio

Subject: Re: Concept - Task ratio
From: Tony Chung <tonyc -at- tonychung -dot- ca>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 2 Feb 2011 12:09:02 -0800

On Wed, Feb 2, 2011 at 11:54 AM, Mike Starr <mike -at- writestarr -dot- com> wrote:
> [real-world examples of where we need the *Why* in addition to the *How*]

I agree that Why is often necessary, and should be linked as related
topics. I think this goes back to John's other question about whether
metadata is important or not, and in this case, I think meta fields
should be used to add weight to How topics so they are not buried by
the Why.

When a previous company interviewed users of our documentation, they
found search to be of paramount importance. The search engine should
able to handle queries structured as questions or statements and not
just search on the collection of keywords.

Meta data could be set up to provide search keys for those phrases:
- How to {perform x feature} with {y}
- When to {perform x feature} with {y}
- etc.

Conversely, the meta data for concept tasks could include:
- The best use of {x feature}
- The history of {x feature}
- More than what you need to know of {x feature}
- etc.

Do current content production systems allow for this?

-Tony
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

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/archive%40web.techwr-l.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


References:
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

Previous by Author: Re: Failure of spoken hyphenation
Next by Author: Re: Customer-friendly word for "landline"
Previous by Thread: Re: Concept - Task ratio
Next by Thread: Re: Concept - Task ratio


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

Sponsored Ads


Sponsored Ads