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.
My team has been "tasked" with a very specific analysis of our products.
What this means is that each writer will take a component from each product
and document EVERYTHING about it: how it works, how to install and configure
it, etc. Each writer must create a list of all possible things each
component can do, and then create end-user documents. These documents are
online "solutions" that are part of my company's public knowledgebase, which
means the documents must be short and concise. Writers don't have pages and
pages to explain components and document steps for installing, configuring,
etc. Writers CAN'T use HTML (because of the limitations of the editing tool
they're using), but they can add hyperlinks to related solutions or to our
Web site.
In short, how have you tackled such a monstrous task, especially for complex
software that requires a great deal of explanation? The other thing is the
writers aren't supposed to be recreating our user guides or training
manuals. So they're really looking for some direction about the best way to
do this project. They can't pull from existing documentation; they have to
create short, but detailed solutions; there's no way to use HTML; and they
have to go through each component carefully, ensuring they've detailed
everything about each component.
Thank you very much. I appreciate your feedback.
Anna Gosling
Education Services
Check Point Software Technologies Ltd.
2505 N. Highway 360, Suite 800
Grand Prairie, TX 75050
www.checkpoint.com
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
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 ejray -at- raycomm -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
