SSRS Reports Documentation
HI , I have a requirement to document all of our existing SSRS reports and the new ones as well.
Can any body please help me or provide me with an example of how do i document the SSRS reports which i develop ? is there any standards or formal approaches to do this ?
Can any body please help me or provide me with an example of how do i document the SSRS reports which i develop ? is there any standards or formal approaches to do this ?
yeah, to document our reports for the end users, we generally have a screen shot of a sample report page(s) with descriptions of the Parameters that the report uses and breif description of what the results mean. For technical docs we add what stored procedures are behind the report and leave the code to document itself, both the db sp and the rdl files. I do not know of anything that would do this automagically either. Good luck, let us know if you find one.
ASKER
well, i actually If i want to do it in a MS Word doc, what exactly do i have to include in that...does anybody have any example docs or something like that ?
Really it depends what you want to document.
Who is the documentation aimed at? End users, developers, people who may purchase the reports.
Create yourself a template with some headings and go from there.
Title. Created Date. Author. Category. Description. Purpose. Parameters. Output. User interaction (e.g. paging and sorting)
Who is the documentation aimed at? End users, developers, people who may purchase the reports.
Create yourself a template with some headings and go from there.
Title. Created Date. Author. Category. Description. Purpose. Parameters. Output. User interaction (e.g. paging and sorting)
ASKER
Thanks QPR
Yes Please, Documentation should be aimed at end users in particular and also to developers if needed.. we can include details like
Title. Created Date. Author. Category. Description. Purpose. Parameters. Output. User interaction (e.g. paging and sorting)
Can you please help me how do i create it..shall i use MS Word or is there a better way of doing it ? and also can you please tell me what information do i have to include in the Report Header and Footer ?
Yes Please, Documentation should be aimed at end users in particular and also to developers if needed.. we can include details like
Title. Created Date. Author. Category. Description. Purpose. Parameters. Output. User interaction (e.g. paging and sorting)
Can you please help me how do i create it..shall i use MS Word or is there a better way of doing it ? and also can you please tell me what information do i have to include in the Report Header and Footer ?
ASKER CERTIFIED SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
ASKER
Ok thanks QPR, i will do that in MS Word then...as i am a newbie to SSRS, could you please tell me
what information do i have to include in the Report Header and Footer in general ?
for example if i am developing a summary report which provides the total number of patients by sex and age band,
what do u think best fits in the header and footer metadata in the above example ?
Many thanks..
what information do i have to include in the Report Header and Footer in general ?
for example if i am developing a summary report which provides the total number of patients by sex and age band,
what do u think best fits in the header and footer metadata in the above example ?
Many thanks..
you may need to open a new question this so that all experts can offer help. This question dealt with documenting existing reports
ASKER
ok thanks
You want to write up what each report is, what it shows and what parameters it takes?
Or you want to document the code behind the report including the SQL?
Either way, I don't know of any way to programmatically do this. I'm afraid you may have to get busy with MS Word :)