Documentation Requirements/Standards

Has anyone taking a step back and determined what their requirements are
for application/system documentation?



Our documentation is all over the map and I want to set a guideline for
documentation to be used with the end users and support staff. I have
some ideas but was hoping for someone to have put this need in writing
somewhere. Doing the google search or searching technical writing sites
has proven fruitless so far.



I'm thinking of things like:



Brief Description

Business function

How launched/where found

Common name, nicknames



How to Identify the Application

Screen

URL

Printout



Technical Architecture

Server

Application Server

Interdependencies



Workflow Description if applicable



Common problems



Problem Determination Checklist





The intent is to come up with something that will assist help desk
technicians and eventually end users in supporting an application. So
much of what we do is based upon OTJ training and assumed osmosis.









Michael Crump



Manager, Computing Services

Saint-Gobain Containers, Inc.

1509 S. Macedonia Ave.

Muncie, IN 47302

765.741.7696

765.741.7012 f


Make it too tough for the enemy to get in and you can't get out.

This email and its attachments may be confidential and are intended
solely for the use of the individual to whom it is addressed. Any views
or opinions expressed are solely those of the author and do not
necessarily represent those of Saint-Gobain. If it did, it would be
folded, mutilated, watered down, politically corrected, and would show
up a week later if at all. If you are not the intended recipient of
this email and its attachments, you must take no action based upon them,
nor must you copy or show them to anyone.

Please contact the sender if you believe you have received this email in
error.