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.
You've gotten some good advice, particularly from Geoff and Ned. I've
been faced with similar situations, and there is no "easy" answer. A lot
depends on your users' needs and on the interface. (OK, not very helpful
there.)
One thing we did, because of the constraints of time and tools, was to
make a prioritized list of the "how-to" topics that we wanted to cover
and get the developers to put a tab/button on the interface that said
something like "How-to...". It's not ideal, but it worked in that
situation.
I said "prioritized" list, because in the two weeks you have to do the
job, you probably won't get to everything you want to do. If you cover
the most important stuff, perhaps the stuff that seems to give users the
most trouble (as indicated by the bugs and support calls?), you've truly
"added value" to the product and improved the customer experience.
AAAARRRRGGGHHH!!! Did I really type all those buzzwords??? <VBG>
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-