RE: Documenting interconnected systems

Subject: RE: Documenting interconnected systems
From: "Steve Hudson" <steve -at- wright -dot- com -dot- au>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 24 Apr 2001 08:45:38 +1000

Sometimes... just sometimes mind you... I think I'm good <gdrfc>

1. Hardware
a) Power On/Off Procedures.
b) Operating Procedures.
c) Inventory
2. Network
a) Operating Procedures.
b) Monitoring Procedures.
c) Inventories.
d) Diagrams, Charts And Maps
3. System Software
a) Start/Stop Procedures.
b) Control Procedures.
c) Inventory.
d) Using <SW Package 1>
4. Application Software
a) Start/Stop Procedures.
b) Inventory
c) Using <SW Package 1>
5. Client Batch Processing
a) Scheduling Procedures.
b) Miscellaneous Procedures.
c) Daily Work Flow.
d) Scheduling Package Configuration.
e) Job Documentation.
6. Housekeeping Batch Processing.
a) Backup Procedures.
b) Operating Procedures.
c) Flowcharts.
d) Job Documentation.
7. General Operations Procedures.
a) Incident Management Procedures.
b) Monitoring and Fault Determination Procedures.
c) Using Utilities
d) Miscellaneous Procedures
8. Other Client Information

. Generic system manuals must be used to locate information implemented on
multiple platforms. E.g.: CICS commands, DB2 procedures. The use of Generic
System Manuals will reduce the size of Client Operating Manuals whilst
ensuring a wide range of information is available.
. Generic system manuals are broken into sub-system areas, dealing with one
software or hardware product in its entirety as sections.
. The Generic System Manual name will clearly and concisely state the
purpose of the manual. E.g.. The Hardware Manual, The DB2 Manual.
. Client Procedure Manuals are necessary to an outsourcer such as CSC as
they describe the contractual obligations to the client, as well as provide
the instructions required for meeting these obligations. Without a standard
procedure to organise the enormous amounts of information required by one of
these manuals, the resulting library would be a chaotic and confused mess,
with similar pieces of information being stored in vastly different areas
and formats.
. Client Procedure Manuals will outline all functions required to service a
Client's Contract in regards to Operating a Computer System.
. The Title shall clearly indicate the client concerned.
. Use extensive cross-referencing between these books and the Generic
Systems manuals to reduce the book size, data redundancy levels and the
reader's search time.
. A Client Procedure Manual content checklist includes, but is not limited
to, the following items.
Contacts for Maintenance, Operation
Power On Procedures
Power Off Procedures
IOCDS Procedures
Partitioning Procedures
Other Configuration Procedures
I/O Procedures
H/W Inventory
Operating Procedures
Naming Conventions
SLA Requirements
Inventory Of Networks
Contacts and Support Groups - Network Operations, Network Support, LAN,
Channel Adapter Connections
Channel Link Stations
SNI Lines
Local NCPs
Remote NCPs
External Lines
Remote Printers
Network Software Inventory
Diagrams, Charts and Maps
Channel Adapter Connections, CDRMs, Channel Link Stations, SNI Lines, Local
NCPs, Remote NCPs, Modems, External Lines, Remote Printers, Naming
System Software
Master Software Inventory
Automation - Timer driven, Event driven
Online Inventory - CICS, IMS, DB2 etc
Software Descriptions
IPL Procedures
Initiator Configuration
Shutdown Procedures
Automatic Commands
Timer Commands
Event Driven Commands
Miscellaneous Procedures
Application Software
Client Batch Processing
Scheduling Package
Calendars and Other Scheduling Info
Job Documentation
Miscellaneous Procedures
Housekeeping Batch Processing
Job Documentation
General Operations Procedures
Incident Management
Monitoring and Fault Determination
Useful Software and Commands
Output Procedures
Other Distribution Procedures
Miscellaneous Procedures
Other Client Procedures


*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at or info -at- devahelp -dot- com

Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27.

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 for more resources and info.

Previous by Author: RE: Documenting interconnected systems
Next by Author: FW: Top ten dumb comment Tech Writers receive from...
Previous by Thread: Re: HUMOUR: Monkeys
Next by Thread: Idea Watch: RE: Well, I Sure Won't Be in Chicago

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

Sponsored Ads