Übersicht

Programmierung

Datenbanken

Schulungen

Dokumentation

Projekte

Rechtliche Hinweise

Dokumentation

Es gibt im Wesentlichen drei Bereiche bei meiner Arbeit, in denen Dokumentation eine wichtige Rolle spielt.

 

· Anwendung

· Sourcecode

· Datenmodell

 

Für den Anwender wichtig ist die Dokumentation der Anwendung selbst, die ihm die wesentlichen Zusammenhänge und Abläufe erklärt.

Dabei lege ich großen Wert auf ein klare, anwenderbezogene Sprache (->„Zielgruppenorientierung“) und direkten

(->„kontextbezogenen“) Aufruf (im Allgemeinen über „F1“ direkt aus der Anwendung).

Folgende Programme wurden bislang von mir zur Erstellung einer Online-Hilfe verwendet:

 

· DocToHelp (Einbindung bestehender Word-Dokumente möglich)

· Visual Basic Help Writer

· Help Writer Assistent HWA

 

Für die spätere Pflege des Programms durch andere Entwickler und natürlich auch durch mich selbst ist eine gute Dokumentierung der Funktionalitäten wichtig. Daher hinterlege ich die wesentlichen Punkte direkt im Sourcecode. Auf Wunsch des Kunden wird zusätzlich eine Zusammenfassung der wichtigen Abläufe in einem Word-Dokument ausgeliefert.

 

Das Datenmodell sollte dokumentiert werden, da es die Grundstruktur der Geschäftsabläufe abbildet. Dazu eignet sich besonders bei größeren Projekten ein Programm wie ERWin, da hier über die Möglichkeiten der reinen Dokumentation hinaus ein jederzeitiger Abgleich der konkreten Datenbank mit dem erstellten Modell möglich ist.

Da ein solches Programm auch aus Kostengründen nicht immer vorhanden ist, bietet sich das Erstellen von dokumentierten Skripten an, die bei Bedarf auch vom Kunden bzw. Administrator ausgeführt werden können.

Hartmut Weiß Software

HaWeiSoft