PDA

Vollständige Version anzeigen : DB Dokumentation?


AliG
14.05.2001, 13:36
Hallo,

ich habe neulich eine DB für meinen Arbeitgeber erstellen müssen und soll diese nun auch dokumentieren und eine kleine Bedienanleitung schreiben.

Frage nun, da ich noch nie eine DB Doku schreiben musste:
Gibt es da eine bestimmt Form, an die ich mich halten sollte? Wie kann diese Aussehen? Was muss alles dokumentiert werden?
Gibt es Software (habe vom sog. Dokumentator gehört) oder Webseiten mit Dokumentationsvorlagen?

Merci für jegliche Hilfe

kaybuch
14.05.2001, 13:38
Hallo,
schau dir mal unter Extras, Analyse den Dokumentierer an.
Der kann schon ein Bißchen was ...
Gruß Kay

AliG
14.05.2001, 13:40
Oh, ist mir noch gar nicht aufgefallen gewesen, damit probier ich mal mein Glück. Merci!!!

O-Schreiner
14.05.2001, 14:32
Sorry, wenn ich Dir jetzt die Träume austreibe, aber meiner Meinung nach dokumentiert der Extras -> Analyse -> Dokumentierer nicht sondern er erzeugt nur Unmengen von (nutzlosem) Papier.

Ich würde in der Doku folgendes gerne sehen:

1. Hardcopy von den Tabellen und den Beziehungen
2. wichtige "Mussfelder" also "Eingabe erforderlich"-Felder irgendwie farblich markiert
3. Hardcopy's der Formulare
4. generelle Beschreibung von Logiken, aber wirklich nur grob und wichtiges, was der "gehe zum Nächsten Datensatz"-Knopf macht darf als bekannt vorausgesetzt werden
5. Vielleicht das eine oder andere Printout (Bericht) als Beispiel (sofern Deine Datenbank das macht)
6. die wichtigsten Abfragen (sofern sie für den Benutzer überhaupt was bringen, also keine Abfragen die "programmtechnisch" erfolgen) und das mit Beispiel-Daten kopiert und in ein Word-Dokument eingefügt.

Damit müssten dann Dein Arbeitgeber und Du selber recht zufrieden sein, wobei Punkt 5 und 6 schon fast Luxus sind.

HTH cu, Olly

O-Schreiner
14.05.2001, 14:33
Nachtrag: Wenns zu wenig Papier sein sollte kannst Du den Packen Papier den Dir der Dokumentieren erzeugt ja als Anlage beiheften ;) weil es steht ja schon alles drin aber halt wirklich alles bis zum allerletzten Klick.

cu, Olly

Ohnesorg
14.05.2001, 15:13
Hi,
bevor Du Dir irgendwelche Sorgen um die Formulierung machst... Schreibe Deine Doku möglichst umgangssprachlich. Mit Fachausdrücken um sich herum zu werfen wirkt für den Otto-Normal-User wie eine Schlaftablette und läßt die Dokumentation ungelesen in einem Schrank verschwinden. Immerhin sollte sie zumindest einmal gelesen sein. Wenn Du schon Fachausdrücke verwenden musst, vergiß nicht ein Stichwortverzeichnis hinten anzuhängen, damit Dein Chef auch weiß, was er dort ließt... :)

Ulf Petersen
14.05.2001, 15:42
Hi,

es ist durchaus sinnvoll, die Dokumentation aufzuspalten: Neben der eigentlichen Doku sollte das User's Manual getrennt erzeugt werden. Ich habe bei meinem eigenen Projekt in der Doku alles beschrieben (Tabellen, Beziehungen, Formulare etc. pp.) in etwa nach dem Muster von Olly Schreiner. Aus diesem Word-Dokument habe ich dann alle Kapitel extrahiert und separat als User's Manual abgespeichert, die für den Anwender interessant sind, also hauptsächlich Formulare, Berichte und die Benutzerverwaltung (natürlich ohne Admin-Passwort ;)). Da meine User sich allesamt nur in den Formularen bewegen und nicht direkt auf andere DB-Objekte zugreifen sollen ist das weitaus zielführender, als sie mit Kapiteln über Beziehungen und Module zu langweilen.

CU

Ulf