Re: Knowledge Base Guidelines

["Amanda Abelove" <bluestreaker1977 -at- hotmail -dot- com>]

I'm doing it from scratch right now.

email me for the pdf.

Tips on Writing Solutions
To assist users in solving their cases, it is important to write good 
solutions. Review the guidelines below, and also see the Tips & Hints for 
Solutions document.

Reusable

 a.. Include all facts and symptoms of the problem.
 b.. Include any necessary analysis or troubleshooting ideas.
 c.. Include a concise, accurate description of the cause and resolution of 
the problem.
 d.. Include only one cause and one resolution per solution. If there are a 
number of steps to the resolution, number each step and put it on a separate 
line.
 e.. Make sure the text is clear and in the language of the intended 
audience - both customer support users and your customers.
 f.. Make sure the title properly describes the problem or question.
     ::  NOTE
       Use a consistent format to ensure that all solutions are reusable. 
You can determine the best format for your organization, but make sure each 
solution contains a title, the symptoms of the problem, the cause of the 
problem, and the resolution to the problem.


Findable

 a.. Make sure the solution can be found by multiple troubleshooting paths 
and by different people who will describe problems in different ways.
 b.. Make sure the solution is unique and can exist as a discrete piece of 
knowledge.
 c.. Make sure the solution is meaningful to your organization and is worth 
sharing with your customers.
Technically Accurate

 a.. Make sure the solution is accurate and up-to-date.
 b.. Make sure the level of technical detail is appropriate for the 
intended audience.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author 
content and configure Help in MS Word or any HTML editor. No 
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com

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