RE: client/server manual

Subject: RE: client/server manual
From: Roger Bell <RBell -at- OptioSoftware -dot- com>
To: Andriene Ferguson <Andriene -dot- Ferguson -at- INEACORP -dot- COM>, TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 5 Oct 2000 11:09:37 -0400


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.

Roger Bell
Technical Writer
Optio Software, Inc.
Decaf espresso...what's the point?

-----Original Message-----
From: Andriene Ferguson [mailto:Andriene -dot- Ferguson -at- INEACORP -dot- COM]
Subject: client/server manual

If you can shed some light on the type of information that should be
included a client/server manual, I would appreciate hearing from you.

Previous by Author: RE: Taking advantage of "reflexive" responses in users
Next by Author: OT: Help with Grant Proposal
Previous by Thread: Re: client/server manual
Next by Thread: RD in Word

What this post helpful? Share it with friends and colleagues:

Sponsored Ads