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.
Subject:Organizing a sprawling doc set From:"Stevenson, Rebecca" <Rebecca -dot- Stevenson -at- workscape -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 12 Jun 2003 13:37:58 -0400
I turn to the wisdom of the list, yet again....
We are currently outlining the doc set for the new product in development. We are still a young department, consist of only two writers (more to come soon I hope), and the requirements are coming in for what looks like about 30 separate guides, plus white papers. Most of it will probably be delivered via PDF with some HTML portions, such as the API and database material.
"We can do this" is what I keep telling myself, but that's not my question. I look at this rapidly metastasizing sprawl of a project and ask: How is anyone going to find what they're looking for?! If it's not obviously related to a particular application within the product, I suspect the answer is "they won't." And that won't do.
We are kicking around the idea of a single, doc-set-wide index. Does this sound feasible? Logical? Do-able with FrameMaker (and I think we're buying IXgen)? Or should we step back and reconsider? Help?
Rebecca Stevenson
Technical Writer
Workscape, Inc.
> 508-861-3059
AIM: RJSWriter
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.