Re: If you were making a FAQ...

Subject: Re: If you were making a FAQ...
From: Brathwaitec <brathwaitec -at- cacctus -dot- net>
To: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
Date: Thu, 30 Aug 2012 16:21:08 -0400


<Kevin -dot- McLauchlan -at- safenet-inc -dot- com> wrote:

> a) Would you include it in online help (WebHelp) if that was the primary documentation for your product?

Yes.

> b) If yes, then would you make it one big FAQ topic/page, or would you make each Q and A a separate topic/page under a FAQ "book" in the ToC?
>
>
All on one page.

> Why?
>
It is easier for the user to scan and print. Also sometimes the user knows what they want to ask but not how. Being able to easily see other similar questions and answers is helpful. I also think too much clicking is annoying for some people.

That being said, if the FAQ is very long I will consider breaking it up into smaller chunks and placing those on separate pages. But it is often just as easy to organize a single page and add links to different sections near the top of the page.

Chantel
> The information contained in this electronic mail transmission
> may be privileged and confidential, and therefore, protected
> from disclosure. If you have received this communication in
> error, please notify us immediately by replying to this
> message and deleting it from your computer without copying
> or disclosing it.
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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://bit.ly/doc-to-help
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as brathwaitec -at- cacctus -dot- net -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

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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://bit.ly/doc-to-help

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

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


Follow-Ups:

References:
If you were making a FAQ...: From: McLauchlan, Kevin

Previous by Author: Re: document design: I don't know what I don't know
Next by Author: RE: Construction terminology question
Previous by Thread: If you were making a FAQ...
Next by Thread: RE: If you were making a FAQ...


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

Sponsored Ads


Sponsored Ads