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: Online Help vs. Knowledge Base vs. FAQ From:Tony Chung <tonyc -at- tonychung -dot- ca> To:Sue McKinney <smckinn2001 -at- gmail -dot- com> Date:Wed, 23 Jul 2014 09:43:42 -0700
I totally disagree with the use of FAQs unless they are intended for
presale information to push clients into the "buy" zone. In this case I
prefer product comparison tables to the generic question and answer format.
Online help as you said is good for reference and systematic training. This
should be beefed up as required based on the most common use cases.
KB works great for specific, unique solutions. The best KB are customer
driven. These should be curated to both remove ineffective
(unrecommended) solutions and discover usage material to move to the online
help. A stackoverflow site may be better than hosting your own.
Just my thoughts.
On Tuesday, July 22, 2014, Sue McKinney <smckinn2001 -at- gmail -dot- com> wrote:
> In my job we have all 3 of these available, and we're now trying to figure
> out what's what and what should be in each. Here's my working start of a
> 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.
> Our problem is too much documentation and it may be that we have some
> duplicate material in these different resources. What do you recommend?
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l