RE: Placement of FAQ's

Subject: RE: Placement of FAQ's
From: "Neumann, Eileen" <ENeuman -at- franklintempleton -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 19 Nov 2004 09:08:25 -0500


I agree that FAQs are more of an online phenomenon. For online, you'd probably include a link to FAQs on the home page.

The problem with putting info into a FAQ format is that it's hard to index by subject - it tends to cover many subjects on one page. For online use however, info in a FAQ may be returned in in a search on a specific subject. This option isn't available in a manual.

I'd think a troubleshooting guide should be called just that. It could have a list of possible problems as headings. For me, the question answer format isn't that useful when trying to convey detailed information.

HTH,
Eileen

Eileen Neumann
Business Rules & Procedures Specialist

FRANKLIN TEMPLETON INVESTMENTS



-----Original Message-----
From: Oja, W. Kelly [mailto:w -dot- kelly -dot- oja -at- verizon -dot- com]
Sent: Friday, November 19, 2004 8:44 AM
To: TECHWR-L
Subject: RE: Placement of FAQ's




Bonnie stated:
>Do manuals now have FAQs? I associate that term with Web sites.

The idea of having a FAQ in an internal manual I am writing was
suggested to me. I am thinking that a TOC & index should suffice, but I
do need something along the lines of a troubleshooting guide, i.e. XXXX
for Dummies.


Notice: All email and instant messages (including attachments) sent to or from Franklin Templeton Investments (FTI) personnel may be retained, monitored and/or reviewed by FTI and its agents, or authorized law enforcement personnel, without further notice or consent.

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

ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!

RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: RE: Hybrid document: user guide & training workbook
Next by Author: RE: Placement of FAQ's
Previous by Thread: RE: Placement of FAQ's
Next by Thread: Re: Placement of FAQ's


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


Sponsored Ads