Dokumentation SQL-Datenbank

[Don_2020]

Gibt es Beispiele für eine gute Datenbank-Dokumentation?
Ich möchte meine Datenbank so Dokumentieren, dass ein Dritter am Projekt möglichst ohne Rückfragen damit arbeiten kann. Ggf. soll ein Dritter auch das Projekt alleine weiter führen können.
Wie machen das die Profis?

Nutze mariaDB, Texstudio und LibreOffice. Spezielle, kostepflichtige DB-Tools sind nicht gewünscht. Es handel hier um ein privates Freizeitprojekt.

Wie Dokumentiert Ihr so eure SQL-Datenbanken?

 

[aluis]

Ein ERD ist schonmal super. Wenn man vernünftig mit Primär und Fremdschlüsseln gearbeitet hat, kann man sowas automatisch erstellen. Ordentlich gepflegte Merkmalbeschreibungen sind dann auch mit drauf.

Programmierbarkeit ganz klassisch mit Quelltextkommentaren versehen.

Sich die Mühe machen, mit dutzenden von Seiten Prosa die Datenbank beschreiben, wäre sicherlich in einer perfekten Welt wünschenswert. Habe ich aber noch nie in der Praxis gesehen und würde wohl auch niemals jemand lesen...

 

[madmax2010]

Nutze mariaDB, Texstudio u

https://tex.stackexchange.com/quest...e-an-er-diagram-using-tikzpicture-environment

Dannnutze tikz

 

[h00bi]

Mir reicht eigentlich eine Tabellenbeschreibung, da die Tabellennamen ja teilweise recht kryptisch sind.
recb -> Rechnungsbelege
recp -> Rechnungspostition
xrec? -> Archivtabelle
Was die Felder machen und wie sich das zusammensetzt, sieht ein fähiger Nachfolger dann schon.

 

[Don_2020]

@madmax2010 Danke für den Tipp. Das Paket kannte ich noch nicht.
@h00bi Fähiger Nachfolger - gute Problembeschreibung