RE: If you were making a FAQ...

Subject: RE: If you were making a FAQ...
From: "Wroblewski, Victoria" <vwroblewski -at- NECsphere -dot- com>
To: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>, Brathwaitec <brathwaitec -at- cacctus -dot- net>
Date: Thu, 30 Aug 2012 15:46:44 -0500

-----Original Message-----
From: McLauchlan, Kevin
Sent: Thursday, August 30, 2012 3:31 PM
Subject: RE: If you were making a FAQ...

Thanks. I'm currently using a single page, that has not yet reached what I would consider "very long" - a moving target, to be sure.
My cow-orker also favors this approach because otherwise each separate FAQ topic would have an H1 heading to start, which would make it a new chapter if/when we decided to generate a print/PDF version rather than the usual WebHelp/HTML5-help version.

But another opinion was that separate pages make more sense for scanning in a ToC (as long as the titles are descriptive), and are just as searchable as a giant one-pager.

>>>

You can still do a manual TOC on the single page... I've done that in the past where things go especially long. We started with some common general troubleshooting things, then had the lists of the other FAQ items in groups.

The biggest argument for keeping it a single page was always that if it was all on one page, a user may be more likely to try a few things or look around, rather than just go to one page, have their problem/question not addressed, and then throw up their hands and call customer service (which we were trying to prevent).

- V

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


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

Previous by Author: RE: Your fave search-and-replace tool
Next by Author: OT: 11 English Resume writing techniques for bilinguals
Previous by Thread: RE: 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