Re: Online Help vs. Knowledge Base vs. FAQ

Subject: Re: Online Help vs. Knowledge Base vs. FAQ
From: "Stuart Burnfield" <slb -at- westnet -dot- com -dot- au>
To: "Techwr-l" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 23 Jul 2014 14:41:48 +0800

If a question really is being frequently asked it implies there's a
design flaw in the product or a hole in the docs. You can fix these
problems once they're reported but if you can't deploy the updated
product or help topic to all customers immediately, FAQs are a good
bridge to make this sort of information available to customers in the
interim.

You should make it clear what build or version of the software the FAQ
relates to. You can retire individual FAQs after a suitable interval,
perhaps once the affected version goes out of support.

If your Online Help is packaged with the software, it would be good
if you can distribute updated help files along with updates to the
software itself.

If it's browser-based help served over the net, you should really just
publish the updated information in the online user guide, and not make
customers look in two places for answers to their questions.

A KB is a good place for niche information, such as:

* Procedures that are specific to older versions

* Integration with third-party products

FAQs could probably be merged into the KB, like this:

* Customers ask how data can be exported for analysis using DB2.
* FAQ document is published describing a 4-step procedure for doing
this using V5.1 of your software.
* DB2 Export wizard is added in V5.2 and covered in V5.2 online help.
* FAQ document is stamped as applicable to V5.1 and earlier versions
and is moved out of the FAQ list into the main KB. A note is added
pointing to the DB2 Export topic for V5.2 users.

* V5.1 eventually goes out of support and the KB document is
archived.

--- Stuart

> Online Help = online user guide with introductory material and
procedures
> FAQ = answers to questions users ask most often, with links to
online help
> KB = troubleshooting/workarounds for strange things
>
> My thinking is that the KB would change as issues are resolved.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Previous by Author: Re: _"Infographics_—_A_Special_Mode_of_Technical_C ommun ication"
Next by Author: Online Help vs. Knowledge Base vs. FAQ
Previous by Thread: Re: Online Help vs. Knowledge Base vs. FAQ
Next by Thread: RE: _"Infographics_â_A_Special_Mode_of_Technical_Commun ication"


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

Sponsored Ads


Sponsored Ads