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.
Assuming the audience is for IT professionals, I would include these topics,
not necessarily in this order. You may also need a client document (User
Guide or online Help).
1. Feature Overview
2. Minimum Requirements (for server, client, and network) Include hardware
and software requirements.
3. Pre-Installation Checklist (Does anything need to be installed before
your product? What other things need to be checked?)
4. Installing the Server Software (Include configuration information or make
it a separate topic.)
5. Technical Operation (How does it all work?)
6. Maintenance (Is there some database that needs to be purged or backed up?
Any other maintenance?)
7. Security Issues or Procedures
8. Support Tips (things to note that may prevent support calls)
9. Glossary
Good luck.
Regards,
Roger Bell
Technical Writer
Optio Software, Inc. http://www.optiosoftware.com
Decaf espresso...what's the point?
