Re: O&M vs. User vs. System Guide

Subject: Re: O&M vs. User vs. System Guide
From: "Marilyn Baldwin (mlbb -at- capgroup -dot- com)" <Marilyn_Baldwin -at- CAPGROUP -dot- COM>
Date: Wed, 17 Jun 1998 09:35:01 -0700

Gina -

Here's my take:

System Guide - describes the whole system, its platform(s),
architecture, components, functionality, etc. - its audience can vary;
it may be intended for application/development programmers,
knowledgeable users, technical management
Operations and Maintenance Guide - contains an intro that is usually a
condensed version/high level of the System Guide, plus details for the
Data Center (if it's a mainframe application) or Network Support (if
it's a client-server app) so that they can perform typical operations
and maintenance functions: apply patches/install service releases, do
performance tuning, correctly respond to error messages, do
troubleshooting, and so on.
User Guide - also contains a condensed overview of the system (why it
exists, what it does, how), info on how to logon (userID, password
requirements, web access if applicable, etc.), usually screen prints
with step-by-step text to walk them through major functions of the
system (e.g., Making Beneficiary Changes to a Policy), and often a FAQ
section.

These are EXTREMELY brief descriptions, but you didn't seem to be asking
for lengthy explanations, so hope this helps.

- Marilyn Baldwin (mlbb -at- capgroup -dot- com)



From: Gina Hertel <Ghertel -at- ALPHA88 -dot- COM> AT Internet_Gateway on 06/17/98
11:21 AM

To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU AT Internet_Gateway -at- ccmail
cc: (bcc: Marilyn Baldwin/CDS/CG/CAPITAL)
Subject: O&M vs. User vs. System Guide

What is the difference between...?
1.) Operations and Maintenance Guide
2.) User Guide
3.) System Guide

I'm working on a deliverable right now, and I'm not sure what to call it.

Gina Hertel
Manager, Technical Communications
Alpha Technologies, Inc.
(732) 980-1288 ext. 749
ghertel -at- alpha88 -dot- com




Previous by Author: Re: grammar/spelling question
Next by Author: Re: New Question - online doc vs hard doc
Previous by Thread: O&M vs. User vs. System Guide
Next by Thread: Re: O&M vs. User vs. System Guide


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


Sponsored Ads