SQL Clone
SQLServerCentral is supported by Redgate
 
Log in  ::  Register  ::  Not logged in
 
 
 


How do you document your reports?


How do you document your reports?

Author
Message
Cris E
Cris E
SSC-Addicted
SSC-Addicted (463 reputation)SSC-Addicted (463 reputation)SSC-Addicted (463 reputation)SSC-Addicted (463 reputation)SSC-Addicted (463 reputation)SSC-Addicted (463 reputation)SSC-Addicted (463 reputation)SSC-Addicted (463 reputation)

Group: General Forum Members
Points: 463 Visits: 642
Requirements for me start with a business description in business terms so that no bad assumptions get made about how tools work or what data will or won't be included or if something can be done. This includes business defining the audience and security needs in their terms. Then you can get into tools, data sources, columns, breaks/groups, sorts and parameters and finally dig into security rules in IT terms. If there are calculations then those need to be laid out in detail. Provide spots to define charts and graphs,alternative calendars, foreign languages or specific output formats (ie PDF or XLS.) You may want to add a spot for testing and also make note of any unusual decisions or events that affected the final product.

You can have separate change control versions of this doc that only include deltas, who was involved in the request, the work and the testing, and if any tradeoffs had to be made.

One other thing to consider for the future is adding a report description into the original requirements template so while business is still sitting there they can help craft a short blurb that you can use for casual users. Most of the time they need a lot less documentation than you think.

Last point: in my humble opinion these docs are almost never searched or referenced except when something goes wrong, so maybe don't bother with a fancy system and stay with Word or Excel. If you have something on hand or there's a corporate standard then go ahead. But these have as much value of their value in CYA as anything else so they just need to be accurate, not powerful or integrated or whatever. MS file servers have the ability to search contents anyway, so simple might be better. YMMV.

Are you lost daddy? I asked tenderly.
Shut up he explained.

- Ring Lardner
amc-885860
amc-885860
SSC-Enthusiastic
SSC-Enthusiastic (133 reputation)SSC-Enthusiastic (133 reputation)SSC-Enthusiastic (133 reputation)SSC-Enthusiastic (133 reputation)SSC-Enthusiastic (133 reputation)SSC-Enthusiastic (133 reputation)SSC-Enthusiastic (133 reputation)SSC-Enthusiastic (133 reputation)

Group: General Forum Members
Points: 133 Visits: 560
Chris,

I am a newbie to BI and SSRS and I have been task to do the same exact thing you're trying to do now.
Go to this link for templates of this nature.

http://mike2.openmethodology.org/wiki/CategoryBigGrineliverable_Templates

This is the main page for 'Deliverable Templates'. Look under the letter "R" for the following:

1. Report Design and Protyping Deliverable Template
2. Reporting Requirements Deliverable Template

This might be what you are looking for. I'm curious to know what you think. Will you reply back to me to let me know. I would appreciate it. Thanks. amc@liq.wa.gov
Ben Wilson-179630
Ben Wilson-179630
SSC Veteran
SSC Veteran (290 reputation)SSC Veteran (290 reputation)SSC Veteran (290 reputation)SSC Veteran (290 reputation)SSC Veteran (290 reputation)SSC Veteran (290 reputation)SSC Veteran (290 reputation)SSC Veteran (290 reputation)

Group: General Forum Members
Points: 290 Visits: 192
we have a report spec document to complete for each report. The front cover has a change log which details the help desk ticket for the change, and a very brief summary of the changes.

There is a general blurb about what the report is for, who owns it, etc.

Next we have the generic selection criteria for a record to be included (in plain english), followed by a table breaking it down into each field the business wants included. the table has these columns:
Field Name (as they want displayed on the report - completed by the business)
Business Logic (plain english description of what it displays - completed by the business)
Calculation (SQL snippet, calculation, etc completed by IT to show how we will get the value)
Data Source (database or other source the data comes from)

seems to work pretty well!
Go


Permissions

You can't post new topics.
You can't post topic replies.
You can't post new polls.
You can't post replies to polls.
You can't edit your own topics.
You can't delete your own topics.
You can't edit other topics.
You can't delete other topics.
You can't edit your own posts.
You can't edit other posts.
You can't delete your own posts.
You can't delete other posts.
You can't post events.
You can't edit your own events.
You can't edit other events.
You can't delete your own events.
You can't delete other events.
You can't send private messages.
You can't send emails.
You can read topics.
You can't vote in polls.
You can't upload attachments.
You can download attachments.
You can't post HTML code.
You can't edit HTML code.
You can't post IFCode.
You can't post JavaScript.
You can post emoticons.
You can't post or upload images.

Select a forum

































































































































































SQLServerCentral


Search