Konzept der Anwendung dokumentieren

[Crow T. Robot]

Hallo zusammen!

Wie kann man am besten die Konzipierung es zu erstellenden Programms dokumentieren? Es handelt sich bei mir um eine VB6-Anwendung und viele Funktionen kümmern sich nur um die Ereignissteuerung die der Benutzer mit der GUI auslöst. Der Aufwand für PAP/Struktogramm zu jedem Teil scheint mir viel zu hoch. Doch irgendwie muss man in der Doku ja einen Gesamtüberblick über den Aufbau und die Funktionsweise des Programms bekommen.

Hat da jemand eine Idee? Gibt es eine sinnvolle Form, wie man z. B. den gegenseitigen Aufruf der Module und Funktionen darstellen kann? Einen Plan ähnlich wie für den Datenfluß kann man auch schlecht auf einem A4-Blatt unterbringen, da es insgesamt etliche Dutzend (aber zum Großteil sehr kleine) Funktionen sind.

[Crow T. Robot]

Schade dass ausser mir auch niemand eine Idee hat. Vielleicht habe ich mich auch unverständlich ausgedrückt...

Es geht darum dass ich nicht alle Programmfunktionen (das sind ein paar Dutzend) in der Konzeptphase dokumentieren kann (PAP oder Struktogramm), der Aufwand wäre viel zu gross. Daher suche ich nach einer Möglichkeit, zumindest den allgemeinen Programmablauf grafisch darzustellen, so dass bestenfalls auch der gegenseitige Aufruf der Modulfunktionen deutlich wird.

Hat dazu jemand eine Idee?

[oversize]

Hi Crow T. Robot,

ich habe wirklich ein Liste mit allen Funktionen und Klassen gemacht, und jeweils 1-2 Sätze zur Funktionalität geschrieben. Du kannst die Funktionen doch sicher nach Modulen aufteilen. btw. wenn du so viel einzelne Funktionen hast, kann man da nicht noch über mehr Kapselung nachdenken?

so wie ich dich verstehe sind die Funktionen ja teilweise schon in eigenen Modulen, dann Fang doch ruhig an alle Module und Funktionen zumindest zu nennen, und wenn der Funktionsname nicht aussagekräftig genug ist, dann noch 1-2 Sätze dazu hauen. Ein PAP oder sowas halt ich auch für übertrieben, zumahl es ja mehr um die Funktionalität der Funktionen geht. Und die kann man "schriftlich" ja schneller darstellen.

[IJK]

da gibt es Muster im IT-Handbuch...

vielleicht schaust du dir das mal an.

Ansonsten muss ich meinem Vorredner widersprechen, als Prüfer würde ich schon gerne so was mit PAP/Strukkis oÄ sehen...

LiGrü

Der Prozessmodellierer

Michael

[Crow T. Robot]

Hallo oversize!

Erstmal Danke für deine Antwort.

Eine Liste aller Module und der zugehörigen Funktionen gibt es natürlich. Allein schon, weil die Schnittstellen ja definiert und dokumentiert werden müssen.

Aber daraus alleine ergibt sich natürlich noch kein Programmablauf. Und da der gegenseitige Aufruf der öffentlichen Funktionen quasi "kreuzundquer" verlaufen kann, bräuchte ich eine Tapete, um dort alle Funktionen unterzubringen.

Stichwort Kapselung: Da es sich um eine VB-Anwendung handelt, ist natürlich eine vollständige Modularisierung gegeben. Die meisten Funktionen gehören als Ereignisroutinen zu den jeweiligen Formularen, die Hilfsfunktionen sind themenorientiert auf drei "echte" Module verteilt.

[Crow T. Robot]

Hallo IJK!

Auch dir erstmal Danke für deinen Beitrag.

"Da gibt es Muster".... Ich wollte jetzt schon fragen welche und wofür, bis ich im letzten Moment deine Überschrift "Ereignisdiagramm" gelesen habe...

Im IT-Handbuch kann ich das Stichwort aber leider nicht finden, nur die übliche EPK. Und die ist ja für die Darstellung des Geschäftsprozesses. Hilft mir beim DV-Entwurf also nicht weiter...

Auf PAP/Struktogramm verzichte ich natürlich nicht ganz, aber ich kann auch nicht jede noch so kleine Routine darstellen, das geht vom Zeit- und Platzaufwand her schon gar nicht. Ich beschränke mich dabei auf einige wenige Funktionen, deren Komplexität das auch rechtfertigt...