Operational Manuals - Please Help!

Subject: Operational Manuals - Please Help!
From: Anthony <anthony_colello -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 21 Aug 2002 09:08:32 -0700 (PDT)

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)

Do You Yahoo!?
HotJobs - Search Thousands of New Jobs

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 http://www.ehelp.com/techwr-l

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
http://www.raycomm.com/techwhirl/ for more resources and info.

Previous by Author: Operational Manuals - Please Help
Next by Author: FrameMaker Document Conversion to HTML through RoboHelp??
Previous by Thread: Re: Story of my life?
Next by Thread: RE: Operational Manuals - Please Help!

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

Sponsored Ads