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.
suggestions on how to "hide" UI-based topics in online Help TOC?
Subject:suggestions on how to "hide" UI-based topics in online Help TOC? From:Donna Barbieri <deebeema -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 24 Mar 2008 08:38:06 -0700 (PDT)
Here is the situation - I am working as a contractor
at a company that had a Tech Writing intern (who is
related to someone in dev). This intern produced an
entire WebHelp system for the application. However,
the Help system is 100% UI specific. Topics such as
"using XYZ" really include information about what is
on a particular screen.
I have been tasked with creating "usable" Help for
first time users AND with keeping the existing Help
for a release in the next two weeks.
Since, apparently, this HAS to be there I'd like to
minimize it's impact on users. I am thinking of
introducing the task-based topics as one normally
would and then renaming all the existing topics and
including them in a logical hierarchy (oh, I didn't
mention the current TOC has two levels - which could
be bc there are no keywords and the index suxs - but I
digress yet again...)...anyway, so I want to create a
hierarchy so these topics aren't cluttering the TOC -
question is - what should these "topics" be called I
really want to steer away from "using XYZ Page" and
was thinking "XYZ Options" "XYZ Page" "About XYZ"? Any
suggestions?
____________________________________________________________________________________
Never miss a thing. Make Yahoo your home page. http://www.yahoo.com/r/hs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-