How do you help clients install software?

[John Cornellier <jcornellier -at- abingdon -dot- oilfield -dot- slb -dot- com>]

Hi all,

We are reviewing the documents we include to help deploy a software 
product. Ignoring such post-installation aids as user manuals, reference 
guides, bug trackers, training, and support, I wish to focus on:

- release notes / readme
- installation guide (could be broken in two: quick start + admin & 
config. guide)
- anything else e.g. install wizards, CD blurbs, download instructions, etc.

I'm trying to reach a consensus among various interested parties - tech 
writers, testing, marketing, support, deployment engineers (the guys who 
burn the CDs and check the target operating environments).

There is not much agreement on what these docs are actually supposed to 
do. E.g. some people think that the release notes are a kind of 
quasi-marketing brochure which trumpet the new features, and are used by 
prospective clients to decide whether to upgrade. Others (including me) 
think the release notes should be a "warts and all" late-breaking 
document including known bugs and workarounds.

So I'd be grateful for any pointers to some kind of working definition 
of the components of deployment support documents, or any random 
thoughts on the subject.

Thanks
John
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy.  Watch the demo at http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.