Hallo,
ich habe eine umfangreichere Datenbankanwendung unter Access erstellt. Für die Mitarbeiter - welche die Datenbank benutzen - gibt es auch eine Anleitung. Nun möchte ich die Datenbank auch gerne so dokumentieren, dass ein anderer Admin diese auch zukünftig alleine administrieren kann.
Zwar gibt unter Access den Dokumentierer, aber unter Berücksichtigung aller Tabellen, Abfragen und Berichten kommen da leicht einige 100 Seiten zusammen. Das Ganze wird also nicht sehr übersichtlich.
Meine Frage: Gibt es Vorgaben/Richtlinien, wie Datenbanken sinnvoll und überschaubar zu dokumentieren sind?
Viele Grüße, Stefan Horn
Hallo, Stefan!
Meine Frage: Gibt es Vorgaben/Richtlinien, wie Datenbanken
sinnvoll und überschaubar zu dokumentieren sind?
Ja, ungefähr in jeder Firma 0 bis hundert. Und alle sind unterschiedlich.
Zum einen würde ich die Beziehungen darstellen; diese geben schon mal einen guten Überblick und sind schnell gemacht, weil sowieso vorhanden. Schön wäre natürlich ein entsprechendes ER- oder UML-Diagramm, je nach Gusto, doch ein sauberer Screenshot der Beziehungen kommt dem schon mal nahe.
Den Dokumentierer kannst Du ebenfalls verwenden, ggf. reduziert auf die „interessanten“ Tabellen.
Zum anderen sollten die abgebildeten Prozesse dargestellt werden. Welche Arbeitsschritte werden für was durchgeführt? Welche betrieblichen Prozesse werden wie in der Datenbank abgebildet? Wie integrieren diese sich in den gesamten Arbeitsablauf der Firma? Bei trivialen Geschichten reicht Prosa wohl aus, bei etwas komplizierteren solltest Du geeignete Darstellungen aus dem Workflowmanagement (z. B. Ereignisgetriebene Prozessketten, Petrinetze, Darstellung über Use Cases etc.) wählen.
Du solltest Dir vor allem über die „Zielgruppe“ im Klaren sein: Soll ein Admin am bestehenden Programm und Datenmodell nur administrieren, oder soll ggf. ein weiterer Entwickler zusätzliche Optionen einbauen. Für ersteren langen eigentlich die Hinweise „ändere da und dort“, z. B. bei neuen Usern. Letzteren würden z. B. auch die Entwurfsentscheidungen interessieren: Warum hast Du das Datenmodell so gewählt wie es ist? Wie werden komplexere neue Zusammenhänge integriert?
Als ersten Hinweis, wenn ein Admin verfügbar ist: Setz Dich mit ihm zusammen, erkläre ihm die Datenbank und lass ihn eine Skizze der Dokumentation selbst schreiben („So, ich erklär Dir das. Schreib Dir alles wichtige auf.“). Er müsste dann fragen „Wie?“ und „Warum?“, wenn ihm was nicht klar ist; er sollte sich seine Gedanken basierend auf Deinen Erklärungen mitschreiben. Und daraus kannst Du dann eine relativ passende Dokumentation verfassen, die der Zielgruppe entspricht. Du als Entwickler, der tief in der Materie drin steckt, hast es schwer, eine Dokumentation so zu verfassen, dass andere damit klar kommen, denn Du wirst Dinge weglassen, die für Dich wohl, für andere aber ganz und ganr nicht selbstverständlich sind.
Gruß, Manfred