Report Documentation Template

[Chamopak]

Hi,
I know most of us IT peeps do not like to "waist time" with documentation.
But I am looking for a template to be able to document my created reports and why re-invent the wheel if others already did this?

Question is: Who has a documentation template available for created  Reports
Name:
Purpose
Source:
Package:
Queries:
Pages:
etc.

If anyone has done this, please be willing to share.

Thank you  ;)

[BigChris]

Yep - I include a page in my template with that sort of information to be filled in. I then set a render variable so that it never gets displayed, and put that page at the front. That way, when someone edits the report that page comes up first. I also include a section for change history, so you can see what's been done to the report since it was first written...and who asked for it to be done.

[rhythmz]

I create a page specifically for 'Report Specification' that consists of a multi-row table which includes all the details I think the next developer who comes behind me will need to know about the report including complex formatting, conditional formatting, complex calculations, revision history, package info, SME POC, etc.

I go to Queries section and create a Boolean variable (in Condition Explorer) by right-clicking on Variables..called 'no_print' defined simply as 1=0 (I will explain in a bit).

I go to my properties pane and go up to the page level of the 'Report Specification' page. Under the 'Render Variable' property, I select my 'no_print' variable.

Now when the user runs the report, the spec page NEVER renders because 1 will never equal 0 (The Render Variable only renders the object when the Boolean condition = TRUE).

Hope this helps, God Bless!