TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Sounds like you will be a busy guy soon. Here are a couple off the top of my
1. Contingency Plans
2. Casualty Procedures
3. Emergency Shutdowns and Startups (different than normal
4. Preventative Maintenance Program and Procedures
Information Development Manager
Technical Information Architects, Inc.
7880 San Felipe Dr., Ste 200
Houston, TX 77063
gmcdonald -at- tiainfo -dot- com http://www.tiainfo.com
From: Anthony [mailto:anthony_colello -at- yahoo -dot- com]
Sent: Wednesday, August 21, 2002 12:11 PM
Subject: Operational Manuals - Please Help!
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
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.
* 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
* Testing Procedures
* Deployment of Equipment and Software
* Monitoring Procedures
* Maintenance Aspects
* Repair Procedures
* Day-to-day activities
* Retirement (of the systems)
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.