RE: Technical vs Implementation Guides?

["Rick Bishop" <rickbishop -at- austin -dot- rr -dot- com>]

Pete: We normally consider an implementation guide to be one that 
just gives the customer the minimum information required to accomplish 
the task and is usually procedure based. If they have problems or 
need more help they should refer to...
The technical guide can contain procedures, but more often is a 
compendium of:
. Background, history, scope, ROI, etc.
. Great detail on how a system functions.
. System and network architecture/infrastructure drawings.
. Sub-net and server ip addresses.
. Why it does what it does.
. Defines expected outcomes.
. Warns of possible errors and fixes/workarounds.
. Exceptions that may be needed if your hardware/software/network is
different from the standard setup.
. Links to downloadable resources.
and more...
Rick


-----Original Message-----
From: techwr-l-bounces+rickbishop=austin -dot- rr -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+rickbishop=austin -dot- rr -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of wawelsmok
Sent: Friday, April 20, 2007 6:15 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Technical vs Implementation Guides?

At my company (software company) we seem to have a problem determining the
differences 
between an implementation and technical guide. I'm assuming the key is
audience. What should these guides 
contain? 

Overall what are the most common types of guides (e.g. Installation, 
Administration) and their definitions?

I need to organize the guides we have here at my company but no one here can
explain to me 
what is really needed. :( HELP!

Thanks in advance.

Pete

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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%40web.techwr-l.com


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

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