RE: installation doc

Subject: RE: installation doc
From: "Tim Lewis" <Writer -dot- lewis -at- att -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 14 Feb 2001 17:40:39 -0600

Some of the Installation Instructions that I work on have other headings.
Maybe this will help.

Compatibility
Inspection of the package before installing
Precautions
Overview of the product
Flow charts
System architecture
Check out
Licenses



Subject: installation doc
From: "Jean Rao" <jeanr -at- purpleyogi -dot- com>
Date: Tue, 13 Feb 2001 10:11:51 +0530
X-Message-Number: 2

Hi all,


I joined your list a couple of days back, and i need some inputs on how an
installation guide should look like.

I was asked to write a quick installation guide for a product, and I
finished this with the following headings:
1. System requirements
2. Pre requisites
3. Installation (with screen shots and steps of the entire installation
procedure)
4. Error messages encountered (and their solutions)

Is there something else that i missed out...the director wasn't too thrilled
with this doc?


Jean Rao
Purple Yogi Software (India) Pvt. Ltd.
Tel: 5212624 - Ext 231
Email: jeanr -at- purpleyogi -dot- com
Website: www.purpleyogi.com





^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17)
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See www.forehelp.com for more information and free evaluation downloads

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: Features of a well-written procedure - Summary
Next by Author: RE: CBT tools and project management?
Previous by Thread: Re: installation doc
Next by Thread: FW: installation doc


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

Sponsored Ads


Sponsored Ads