Schreiben einer richtigen Tabelle Beschreibung

Question

Ich schreibe zum ersten Mal Beschreibungen für meine SQL Server-Tabellen (aus dem Description Feld im Properties Fenster), und ich begann darüber nachzudenken, was genau in einem solchen Feld zu schreiben.

Zum Beispiel sind einige Tabellen selbsterklärend nach ihren Titeln ... wie eine Tabelle namens Albums in einem "Music System". Welche Beschreibung würden Sie in einem solchen Fall tatsächlich schreiben?

Und welche "anderen" Informationen enthalten Sie normalerweise in der Beschreibung? Erwähnen Sie die Beziehungen zum Tisch?

Gibt es eine formelle Standardformel zum Schreiben von Beschreibungen für Tabellen?

Answer 1

Ich glaube, ein gutes Objekt Benennung und Design und schließlich ein Tool, das Sie Datenbankstruktur visualisieren würde (e.g. SQL Doc) ist viel besser, dass eine detaillierte Beschreibung zu jedem Objekt hinzufügen.

Je mehr Sie in der Beschreibung behandeln möchten, desto wahrscheinlicher ist es, dass die tatsächliche Datenbankstruktur nicht mehr synchron ist. Z.B. Wenn Sie die Beziehung dokumentieren möchten, müssen Sie bei jeder Änderung daran denken, auch die Beschreibungen zu aktualisieren (an allen beteiligten Objekten?). Es handelt sich im Grunde um redundante Informationen, da sie bereits im Schema aufgezeichnet sind. Wir wollen keine Redundanz, die Datenbank, oder?

Answer 2

Ich würde den Namen der Jobs/Programme/Berichte, die diese Tabelle verwenden, in die Beschreibung eingeben. Dies erfordert natürlich keine ständige Aktualisierung und beantwortet die Frage, warum diese Tabelle existiert. (dh wer ist das Daten?)

Answer 3

Ich würde auch die Kardinalität/Beziehung der Tabelle zu anderen wichtigen Tabellen einschließen. Das mag offensichtlich erscheinen, aber oft ist es nicht so. Zum Beispiel für tblAddresses Sie die Beschreibung haben könnten:

„Diese Tabelle ist eine übergeordnete Tabelle für die Adressdetaillinien (tblAddressLines) und wird durch (und nicht ein Kind) die Tabelle Personal (tblPersonal) verweist.“

Answer 4

Wenn Sie die Quellcodeverwaltung verwenden, kann ich hier keinen Kommentar eingeben, der nicht besser als SCC-Kommentar verwendet werden könnte. Ich denke, es ist überflüssig und würde es nicht verwenden, wenn Ihre Organisation keinen Standard dafür hat.

Answer 5

3 einfache Anweisungen sollten für eine Tabellenbeschreibung tun: eine beschreibt, was die Tabelle enthält, eine beschreibt den Anfangszustand der Daten in der Tabelle (leer oder vorgefüllt), und eine beschreibt, wie Daten in/aus der Tabelle bewegt Tabelle.