Technical vs Implementation Guides?

Rick Bishop rickbishop at austin.rr.com
Fri Apr 20 19:02:21 MDT 2007


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.rr.com at lists.techwr-l.com
[mailto:techwr-l-bounces+rickbishop=austin.rr.com at lists.techwr-l.com] On
Behalf Of wawelsmok
Sent: Friday, April 20, 2007 6:15 AM
To: techwr-l at lists.techwr-l.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



More information about the TECHWR-L mailing list