Schreiben einer korrekten Tabellenbeschreibung

Question

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

Zum Beispiel sind einige Tabellen anhand ihres Titels selbsterklärend...wie eine Tabelle namens Albums in einem "Musiksystem". Welche Beschreibung würden Sie in einem solchen Fall tatsächlich schreiben?

Und welche "anderen" Informationen geben Sie normalerweise in der Beschreibung an? Erwähnen Sie die Beziehungen zur Tabelle?

Gibt es eine standardisierte, formale Vorgehensweise für die Erstellung von Beschreibungen für Tabellen?

Answer 1

Ich glaube, dass eine gute Objektbenennung und ein gutes Design sowie eventuell ein Werkzeug, das die Datenbankstruktur visualisiert ( z.B. SQL Doc ) ist viel besser als das Hinzufügen einer detaillierten Beschreibung zu jedem Objekt.

Je mehr Sie in der Beschreibung abdecken wollen, desto wahrscheinlicher ist es, dass sie nicht mit der tatsächlichen Datenbankstruktur übereinstimmt. Wenn Sie z. B. die Beziehung dokumentieren wollen, müssen Sie bei jeder Änderung daran denken, auch die Beschreibungen zu aktualisieren (bei allen beteiligten Objekten). Das sind im Grunde überflüssige Informationen, da sie bereits im Schema aufgezeichnet sind. Wir wollen doch keine Redundanz in der Datenbank, oder?

Answer 2

Ich würde auch die Kardinalität der Tabelle und die Beziehung zu anderen wichtigen Tabellen angeben. Dies mag offensichtlich erscheinen, ist es aber oft nicht. Für tblAdressen könnte man zum Beispiel die Beschreibung haben:

" Diese Tabelle ist eine übergeordnete Tabelle für Adressdetails (tblAddressLines) und wird von der Tabelle Mitarbeiter (tblEmployees) referenziert (und ist KEIN Kind dieser Tabelle). "

Answer 3

Für eine Tabellenbeschreibung sollten drei einfache Aussagen genügen: eine, die beschreibt, was die Tabelle enthält, eine, die den Anfangszustand der Daten in der Tabelle beschreibt (leer oder vorausgefüllt), und eine, die beschreibt, wie Daten in/aus der Tabelle bewegt werden.

Answer 4

Ich würde den Namen der Stellen/Programme/Berichte, die diese Tabelle verwenden, in die Beschreibung aufnehmen. Es ist unwahrscheinlich, dass dies ständig aktualisiert werden muss, und es beantwortet die Frage, warum diese Tabelle existiert? (d.h. Wessen Daten sind das?)

Answer 5

Wenn Sie die Quellcodekontrolle verwenden, fällt mir kein Kommentar ein, der nicht besser als SCC-Kommentar verwendet werden könnte. Ich denke, es ist überflüssig und würde es nicht verwenden, es sei denn, Ihre Organisation hat einen Standard dafür.