Documenting Processes

[redvan]

Hello,
I need to document several complex processes that my company uses. They are programmed processes as in they start from a menu, may or may not require input and then either go to batch or run interactively. I was wondering what would be the best approach. Flow charts are easy and I've done many but they lack depth, as in details and description, instructions, what-ifs, and other details.

Any suggestions or ideas?

Mike.

[VilenaP]

I usually create a Word document if I want something that is detailed. I start with a paragraph that give a brief description of the process. I then create a list of the main programs in the process and create a bullet point list for each of them giving details such as purpose of the program, primary file, any programs that are called, any input received and how it is received, where the data is output, etc.

i.e. Store Polling

1. ProgA - Pick up polling files
   1. files picked up from ServerZ every x minutes/hours
   2. call/submit ProgB
2. ProgB - Process polling file
   1. outputs to Inventory file, Sales file, Customer file and Payroll file
   2. submits the following programs
      1. ProgC - process Inventory transactions
      2. ProgD - process Sales transactions
      3. ProgE - process Customer data
      4. ProgF - process Payroll data
3. ProgC - process Inventory transactions
   1. update inventory files to reflect sales made
   2. update inventory files to reflect inventory received

Hope this helps.
Vilena