Was ist Ihr bevorzugtes Dokumentenformat für die Dokumentation von Datenbanken [geschlossen]

8

Ich schreibe gerade eine Anwendung , die unter anderem die MediaWiki-Dokumentation eines MSSQL generiert Datenbank (Objekte, Tabellen, Tabellendaten).

Meine Frage ist, welche Dokumentformate Sie bevorzugen oder erstellen müssen. Ich habe zu viele Ideen, denen ich folgen sollte, daher sollten meine Antworten meine Prioritäten setzen;)

(Ich weiß, es gibt andere dokumentationsbezogene Fragen zu SO, aber sie beschäftigen sich hauptsächlich damit, wie man Dokumentation generiert (ich weiß wie) und nicht nach bestimmten Dokumenttypen oder Plattformen fragt)

Bearbeiten: Danke für die Kommentare. Eigentlich habe ich schon Tabellenbeziehungen, da ich Fremdschlüssel parse. Der vollständige Querverweis kann jedoch etwas kniffliger sein;)

Die Frage sollte jedoch nach den Dokumenttypen wie Word, PDF, ODF usw. fragen. Was sind Ihre beruflichen Anforderungen oder Vorlieben?

Aktualisierung: Übersicht der generierten Dokumentation

    
devio 11.01.2009, 23:19
quelle

2 Antworten

7

Es klingt, als hätten Sie sich bereits für ein Dokumentformat entschieden, bei dem es sich um HTML handelt, das auf MediaWiki-Markup basiert.

Sie sollten auch Entity-Relationship-Diagramme generieren, die nützliche Ergänzungen zur Datenbank-Dokumentation sind (obwohl ERDs dies nicht tun) erzähle die ganze Geschichte entweder).

Meinst du Dokumentenorganisation, d. h. welche Überschriften und Inhalte sollten auf jeder Seite enthalten sein?

Hier sind einige Vorschläge:

  1. Tabellenstruktur

    • Spaltennamen, Datentypen, Einschränkungen
    • Bedeutung und Verwendung jeder Spalte
    • Zusätzliche logische Einschränkungen in Triggern und Anwendungscode
    • Indizes definiert

  2. Beziehungen zu anderen Tabellen

    • Von diesem abhängige Tabellen
    • Diese Tabelle hängt von
      • ab
    • Hinweise zu speziellen oder impliziten Beziehungen, die nicht durch Datenbankeinschränkungen durchgesetzt werden

  3. Verwendung der Tabelle

    • Verwendung in gespeicherten Prozeduren
    • Verwendung im Anwendungscode
    • Verwendung in Ansichten
    • Wer hat Lese- und / oder Schreibzugriff? SQL-Berechtigungen für jeden Benutzer oder jede Rolle

Es gibt andere Fragen bei StackOverflow, die diesem sehr nahe kommen.

Bill Karwin 12.01.2009, 00:05
quelle
0

Vielleicht möchten Sie sich ansehen, was die kommerziellen Anbieter diesbezüglich tun. Wie Bill sagte, brauchen Sie sicherlich ein ER-Diagramm. Zu den zu betrachtenden kommerziellen Produkten könnte gehören: Embarcadero ER / Studio Embarcadero ER / Studio Red-Gate SQL Doc , Power Designer und andere.

    
Mark Allison 12.01.2009 13:19
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Nützliches Tutorial für reguläre Ausdrücke [geschlossen]