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.
Re: Documentation by FAQ (was: Question marks in titles?)
Subject:Re: Documentation by FAQ (was: Question marks in titles?) From:"Mike O." <obie1121 -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 1 Feb 2005 09:40:46 -0800 (PST)
Lisa Wright wrote:
> Information is buried two or three levels deep; sometimes the
> user has to identify the category the question might be in
> before they can see the questions. On the surface, it *appears*
> to be task-oriented because the questions supposedly answer the
> user's need to *do* something.
Sounds like the text is OK and you just have a navigation problem.
Perhaps you can build an alternate TOC that suppresses the Q's and
provides traditional task-oriented headings instead (while keeping the
body text the same). Once you get a handle on how to build alternate
views, you could then offer users the choice of "View as FAQ..." "View
as TOC..." etc.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
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.
