September 23, 2003 at 2:07 am
I just recently realize that our customer can't always depend on us as a consultant to manage their data. So, I think it would nice for customer to have a guide of how to view or query their database by doing it by themselves. In order to do that, I think they need some documentation of existing database. Do you guys have a sample of database documentation, which can be used as a guide for your customer ? Thanks in advance.
September 23, 2003 at 6:19 am
Documentation on the database can be as simple as what databases are on which servers.
It depends on the contract with the client on the level of documentation. Some receive an ER diagram, some receive a list of the tables, etc. Most of the clients that I have dealt with are comfortable with a description of the tables (lookup, data entry), a description of what each of the stored procedures do and what the views capture.
It's best to follow the contract that you have with the client on database documentation.
Dr. Peter Venkman: Generally you don't see that kind of behavior in a major appliance.
Patrick
Quand on parle du loup, on en voit la queue
October 20, 2004 at 3:20 pm
Hi, there are a couple of products out there that will even build the documentation for you, so you don't have to waste time writing things up. 2 that come to mind are DB Quick Docs, http://www.agilist.com and SQL Scribe http://www.agsoftware.com . You tell the software which tables, stored procedures or views, etc that you want to document and the software gathers the data and puts it in a nice HTML help document that you can give to your clients - a nice value added approach that saves time and impresses.
October 21, 2004 at 6:59 pm
You should also check out ApexSQL Doc. http://www.apexsql.com It is fairly new and I just heard about it. I have tested it and it does a great job of documenting everything. It produces a a full HTML help doc. Pretty cool too, it has a command line interface.
-Frank
May 2, 2011 at 11:58 am
Here is one more Tool to document Sql Server Database
May 2, 2011 at 3:36 pm
A guide for people to write their own queries? Completely unqualified people? No. I wouldn't suggest that. Instead set up a reporting system with templates and models that they can use to build their own reports, but control the queries as much as you can.
"The credit belongs to the man who is actually in the arena, whose face is marred by dust and sweat and blood"
- Theodore Roosevelt
Author of:
SQL Server Execution Plans
SQL Server Query Performance Tuning
May 2, 2011 at 3:40 pm
Please note: 8 year old thread.
Gail Shaw
Microsoft Certified Master: SQL Server, MVP, M.Sc (Comp Sci)
SQL In The Wild: Discussions on DB performance with occasional diversions into recoverability
Viewing 7 posts - 1 through 6 (of 6 total)
You must be logged in to reply to this topic. Login to reply