RE: Operational Manuals - Please Help!

Subject: RE: Operational Manuals - Please Help!
From: Guy McDonald <gmcdonald -at- webmail -dot- tiainfo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 21 Aug 2002 11:43:32 -0500

Hi Anthony -

Sounds like you will be a busy guy soon. Here are a couple off the top of my
head ...

1. Contingency Plans
2. Casualty Procedures
3. Emergency Shutdowns and Startups (different than normal
4. Preventative Maintenance Program and Procedures

Kind regards,

Guy McDonald
Information Development Manager
Technical Information Architects, Inc.
7880 San Felipe Dr., Ste 200
Houston, TX 77063
gmcdonald -at- tiainfo -dot- com
-----Original Message-----
From: Anthony [mailto:anthony_colello -at- yahoo -dot- com]
Sent: Wednesday, August 21, 2002 12:11 PM
Subject: Operational Manuals - Please Help!

Hello Everyone,

I'm kind of new at writing operational manuals and
desperately need some input. I'm slated to go on a
business trip next week to talk with some techies and
assess the current operational documentation situation
for the company architecture. So I really need the
input! :)

Thus far I have identified the below items that need
to be created or collected. Please tell me if there
is anything I missed or if you think something is not

Thanks for the help.

- Anthony

* Data Flow Diagrams (DFDs)
* Flowcharts Showing Program Logic
* Ensure source code is being documented
* Application Programming Interfaces (APIs)
* Database Schemas
* Network Topologies
* Equipment Lists
* Procedures for blackouts, shutdowns, and backups.
* Security Controls
* System Proposals
* Setup of Equipment and Software
* Designing
* Planning
* Procuring
* Testing Procedures
* Deployment of Equipment and Software
* Monitoring Procedures
* Maintenance Aspects
* Repair Procedures
* Troubleshooting
* Day-to-day activities
* Retirement (of the systems)

Want to support TECHWR-L? Get shirts, bags, hats, clocks,
and more from the TECHWR-L Store. All proceeds support TECHWR-L.

Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at

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: Tools: PDF to SQL
Next by Author: RE: User's, Users, Users'
Previous by Thread: Operational Manuals - Please Help!
Next by Thread: Re: Operational Manuals - Please Help!

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

Sponsored Ads