Re: Reports Documentation (an on-topic topic)

[Helen Obaze <hobaze -at- GOSAFEGUARD -dot- COM>]

Here is how we handle this:

-- Document the use and importance of the report.  For example, Run the
Aging Receivables report every month to obtain a list of customers that
have past due accounts.

-- Document the fields that contain the important the is key to that
report.  For example, in the Aging Receivables report, the key fields would
be the Past due amount, date of order, and so on.

--Always include a sample.  Put callouts describing the key fields/data on
the report.

----------
> From: Joe Sokohl <jsokohl -at- campbellsoft -dot- com>
> To: TECHWR-L -at- listserv -dot- okstate -dot- edu
> Subject: Reports Documentation (an on-topic topic)
> Date: Friday, September 12, 1997 9:35 AM
>
>      We're doing documentation of our reports. Looking for opinions re:
>      reports documentation. Audience level: mid-managerial to CEO/COO.
>      Documentation type: referential.
>
>      -- How do you document software-generated reports?
>
>      -- Do you document each field of a report, or do you only describe
>      specific ones?
>
>      -- Do you see value in documenting every report, or do you only
>      document thorny, hard-to-understand ones?
>
>      -- Do you provide llustrations of sample reports?
>
>      -- Any other thoughts?
>
>      I'm ambivalent (some might say wishy-washy) on the subject. So, any
>      informed opinions are most welcome....
>
>      joe
>      Joe Sokohl
>      Manager of Documentation
>      Campbell Software, Inc.
>      http://www.campbellsoft.com
>
>      The opinions expressed in this mail are mine.
>      They don't necessarily represent Campbell Software or any of its
>      affiliates.
>
>  TECHWR-L (Technical Communication) List Information: To send a message
> to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot-  Send commands
>    to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
>   Search the archives at http://www.documentation.com/  or search and
> browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
>

 TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot-  Send commands
   to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
  Search the archives at http://www.documentation.com/  or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html