Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

  • Congratulations IamaSherpa on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!

Report Documentation

Status
Not open for further replies.

mathew001

Programmer
Jun 28, 2002
25
US
What is a good tool to document the reports ?
 
If you export your report, and choose Report definition as your export format, it creates a .txt file with some good information such as links, formulas fields, etc.

It is not as good as BlurredVisions' suggestions, but it is free. Software Training and Support for Macola, Crystal Reports and Goldmine
251-621-8972
dgilsdorf@mchsi.com
 
Another way is to create a "Read Me" formula that you would add a red background to attract attention , conditionally suppress with the formula, 1 = 1 so that it will be red in design mode and place in the report page footer somewhere out of the way.

the formula would consist of nothing but comment statements. As such, it can be as large as you want. It is very useful especially if there are many developers doing report maintenance.

the format could be

@readme

//Basic report function: <describe the report here
// especially special tricks>
//
//Maintenance log
//===============
//2002/07/23 ngolem - fixed problem with rounding of the
// sum of {table.field1}
//2002/08/08 jDoe - added report footer section as per
// as per Mr. Pickey

you get the basic idea...having this buried in the report allows the report documentation to stay with the report at all times

Hope this helps Jim Broadbent
 
Status
Not open for further replies.

Part and Inventory Search

Sponsor

Back
Top