template
Index :: Anhang :: Projektinfos: Dokumentation der DB-Struktur (
struct.html)
Gerade bei umfangreicheren Projekten mit mehreren SQL-Tabellen ist es hilfreich, sich eine dokumentierte Liste der Tabellen und ihrer Felder zu erstellen. Dies ist in zweierlei Hinsicht dienlich:
- Während der Entwicklungsphase als allgemeine Orientierungshilfe, Erleichterung zum Ziehen von Zwischenbilanzen und Neuordnen von Datenbankstrategien.
- Nach der Fertigstellung des Produktes als Nachschlagewerk und Grundlage für Hilfeseiten, Spezifikationen und Schnittstellenbeschreibungen.
Das Ganze lässt sich auf einer Seite unterbringen, die am besten mit einem Inhaltsverzeichnis beginnt. Darunter folgen dann die einzelnen Tabellenbeschreibungen.
Die Spalte Beschreibung sollte evtl. einen Beispielwert und je nach Feldtyp tiefergehende Informationen enthalten:
- ENUM-Feld: Bedeutung der Zahlenwerte [0...N]
- Flags-Feld: Bedeutung der Bitwerte/-Kombinationen
- Verweis-Feld (ObjektIDs): Link auf die Zieltabelle
Optional können zu den Tabellen noch Bemerkungen (z.B. fehlende oder geplante Felder) hinterlegt werden.
Auszüge aus dem Quellcode von struct.html:
CSS im Header
BODY { BACKGROUND-COLOR:#E8E8E8; COLOR:#000080;
FONT-FAMILY:verdana,arial,helvetica,sans-serif; }
.ind { MARGIN-LEFT:22; }
.txt { COLOR:#003000; }
.rem { FONT-STYLE:italic; FONT-SIZE:80%; COLOR:#606060; }
Weiter unten, im BODY, das Inhaltsverzeichnis:
<h3>MyProject</h3>
<b>DB-Struktur</b>
<div class='ind'>
<div class='rem'><br>Server</div>
<img src='img/iDbTab.gif'> <a href='#webuser'>webuser</a> Mitarbeiter<br>
<div class='rem'><br>Haupttabellen</div>
<img src='img/iDbTab.gif'> <a href='#card'>card</a> Visitenkarte<br>
<div class='rem'><br>Untertabellen</div>
<img src='img/iDbTab.gif'> <a href='#postadr'>postadr</a> Postadresse<br>
<img src='img/iDbTab.gif'> <a href='#phone'>phone</a> Telefonnummer<br>
<img src='img/iDbTab.gif'> <a href='#email'>email</a> EMail-Adresse<br>
<img src='img/iDbTab.gif'> <a href='#webadr'>webadr</a> Web-Adresse<br>
<div class='rem'><br>Zwischentabellen</div>
<img src='img/iDbTab.gif'> <a href='#xpostadr'>xpostadr</a> Objekt <- Postadresse<br>
<img src='img/iDbTab.gif'> <a href='#xphone'>xphone</a> Objekt <- Telefonnummer<br>
<img src='img/iDbTab.gif'> <a href='#xemail'>xemail</a> Objekt <- EMail-Adresse<br>
<img src='img/iDbTab.gif'> <a href='#xwebadr'>xwebadr</a> Objekt <- Web-Adresse<br>
<div class='rem'><br>Hilfstabellen</div>
<img src='img/iDbTab.gif'> <a href='#cids'>cids</a> Objektsammlung<br>
</div>
<br>
Weiter unten, als Beispiel der Bereich von Tabelle webadr (Web-Adresse):
<hr size='1' color='#000080'><!---------------------------------------->
<a name='webadr'></a>
<img src='img/iDbTab.gif'> <b>webadr</b> (Web-Adresse)
<div class='ind'><br>
<table bgcolor='#808080' cellspacing='1' cellpadding='2' border='0'><tr bgcolor='#FFFFFF'>
<td>0</td><td><b>WAID</b></td><td>int</td><td><img src='img/iKey0.gif'> WebAdrID</td>
</tr><tr bgcolor='#FFFFFF'>
<td>1</td><td><b>Adrs</b></td><td>varchar[64]</td><td>z.B. http://www.adac.de/pub/index.htm</td>
</tr><tr bgcolor='#FFFFFF'>
<td>2</td><td><b>Info</b></td><td>varchar[255]</td><td>...</td>
</tr></table>
</div>
<br>
Beispiel für eine struct.html:
| template |
 |