Documenting a data processing application

Subject: Documenting a data processing application
From: Mike Buckler <mbuckler -at- opera -dot- iinet -dot- net -dot- au>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 9 Aug 2001 22:15:17 +0800

Does anyone know of an authoring tool that can assist in documenting
the internals of an application that puts a database record through
several hundred discrete processing steps.
The processing sequence looks like this:
Input record -> step 1 -> step 2 -> ... step 230 -> output record
Each step is designed to detect data errors. Some steps depend on the
results from one or more previous steps.
The application is for the insurance industry. The users are
reasonably technical but have no programming knowledge.

Flow charts tend to break down when you have more than a dozen or
so steps simply because of page size limitations.
A co-worker suggested writing pseudo code (non language specific
source code) for each step.


Mike Buckler

---------------------
Tech writing glossary www.iinet.net.au/~mbuckler/glossary.shtml


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

---
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.


Follow-Ups:

Previous by Author: copyright (was RE: A Question of Ethics ...)
Next by Author: RE: Directly inserting html text
Previous by Thread: Re: What is a word attachment?
Next by Thread: RE: Documenting a data processing application


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


Sponsored Ads