Documenteer je database (MySQL)

Hoe documenteer je je database-applicatie?

Brainstorm

• Daar sprak ik ooit met Frank van Micpoint over. Zij werkten echter op een heel ander abstractieniveau met databases
• Ik geloof sterk in zelf-documenterende systemen. De documentatie moet dus ergens in de database zelf worden opgeslagen - Vooral voor databases ligt dat erg voor de hand. Nog een reden om documentatie binnen de database zelf op te slaan: Een database heeft niet een eenduidige locatie op een computer. Het zit niet op een vaste plek in Dropbox of binnen een webserver. Welke locatie je ook kiest voor stand-alone documentatie, het is altijd min-of-meer kunstmatig
• Tabellen en velden hebben een comment-veld. Schrijven is doorgaans geen probleem. Ontsluiten van die info, vind ik echter niet lekker werken, al moet dat niet al te moeilijk zijn: Daar kun je gewoon queries voor schrijven. Dat heb ik ook al gedaan, maar nog steeds werd ik er niet gelukkig van

Huidige aanpak - Jan. 2021

• Tekst- of LibreOffice-bestanden. Per object een apart bestand
• Ergens op een voor de hand liggende plek (binnen Dropbox)

Bronnen

• https://dbmstools.com/categories/database-documentation-tools/mysql - 33 Tools to document your MySQL-database