Database documentation examples.
-
I'm looking for some good examples of database documentation to use as inspiration (to copy :cool:) for my database documentation. The technical documentation I'm fine with; I can use tools for that to extract it from the DB, but I've hit some writer's block, especially at documenting entities, i.e. tables. OK, I'm using EF, so each of my tables represents an entity model object, and I could use short, on-liners, e.g. the Member table 'stores Member records', but that is a bit useless, so I want to also document what the Member entity is, in the same piece of documentation. Now I am stuck vacillating between one-lines and one-pagers, so I would some examples of well written DB/entity documentation. Any suggestions?
-
I'm looking for some good examples of database documentation to use as inspiration (to copy :cool:) for my database documentation. The technical documentation I'm fine with; I can use tools for that to extract it from the DB, but I've hit some writer's block, especially at documenting entities, i.e. tables. OK, I'm using EF, so each of my tables represents an entity model object, and I could use short, on-liners, e.g. the Member table 'stores Member records', but that is a bit useless, so I want to also document what the Member entity is, in the same piece of documentation. Now I am stuck vacillating between one-lines and one-pagers, so I would some examples of well written DB/entity documentation. Any suggestions?
Just my opinion: Including
Brady Kelly wrote:
the Member table 'stores Member records'
may sound unnecessary but there may be that table the currently everyone knows what it is be two years from now they will not. So I suggest keeping the information.
-
Just my opinion: Including
Brady Kelly wrote:
the Member table 'stores Member records'
may sound unnecessary but there may be that table the currently everyone knows what it is be two years from now they will not. So I suggest keeping the information.
I didn't say documenting the table was unnecessary, I just said I didn't only want to have something that is basically redundant in my documentation.
-
I didn't say documenting the table was unnecessary, I just said I didn't only want to have something that is basically redundant in my documentation.
If there is sufficient documentation that basically describes the point of a table elsewhere then your table documentation should specifically reference that other documentation. By name, by section within the document and perhaps with a link if possible. If a link is not possible then enough information must be provided that someone can reliably find that other documentation...two years from now.
-
If there is sufficient documentation that basically describes the point of a table elsewhere then your table documentation should specifically reference that other documentation. By name, by section within the document and perhaps with a link if possible. If a link is not possible then enough information must be provided that someone can reliably find that other documentation...two years from now.
There is no other documentation. I want the documentation for the database, the only area of the application that my client will be able to easily understand, to be the definitive documentation.