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:Enterprise software - reorganizing the help From:"Patrick and Jenny" <pat_jen -at- hotmail -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 12 Oct 2007 13:16:11 -0700
Hi
I'm interested in talking with people who document large enterprise software
systems.
We want to reorganize our help system so that it is easier to find info and
simpler to update. Currently we have three types of documentation: End-user
procedures (available from the Help menu in the app), Setup Guide (a
standalone chm), and Release Notes (a standalone chm). We also have printed
reference guides with technical information on advanced procedures and
setup, and details of all the screens including background calculations.
We have three different audiences - end-users, their support staff, and our
own high-level support group.
So, I'm wondering where to go from here. There are frequent updates to the
software (every 2 or 3 weeks), so whatever we decide to do, needs to be easy
to update.
Any suggestions? Anyone in a similar situation? How should we organize all
this information?
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-