Zum Inhalt springen

Schwierige Dokumentation


knuti

Empfohlene Beiträge

Hallo,

die Erstellung meiner Projektdokumentation ist soweit im vollen Gange. Jedoch bin ich jetzt auf ein großes Problem gestoßen und benötige Hilfe von Experten, von Euch ;)

zu den Fakten:

Ich bin Anwendungsentwickler und habe meine Projektarbeit hinter mir.

Dabei ging es um ein dynamisch erzeugtes Menü, welches ein

statisches HTML Menü ersetzen soll. Das klingt weniger tragisch,

als es tatsächlich ist.

Die Programmierung selbst ist nicht einmal so viel. Viel größer ist

die Analyse-Phase. Die ist auch in der Dokumentation

dementsprechend lang ausformuliert.

Jedoch ist mein Problem folgendes:

Die Programmierung selbst ist nicht sonderlich lang, jedoch sehr

komplex. 2 rekursive Funktionen, 2 * mehrdimensionale Arrays, die

in den rekursiven Funktionen bearbeitet werden. Außerdem erstreckt

sich das Menü über mehrere Ebenen, weswegen die Funktionen rekursiv

sind.

Programmiertechnisch ist das kein Problem, da ich schon über

ausreichend Erfahrung in dem Gebiet verfüge. Jedoch weiß ich

absolut nicht, wie ich das beschreiben kann, damit jemand Anderes

das versteht!

Meine Idee waren Erläuterungen durch Programmablaufpläne.

Gibt es da noch weitere Möglichkeiten, solches Visuell darzustellen?

viele Grüße

und herzlichen Dank schonmal im Voraus.

Link zu diesem Kommentar
Auf anderen Seiten teilen

Mach nicht so einen Druck! Wir sind nicht so schnell im Denken ;).

Mein Vorschlag: PAP bzw. Struktugramm zur Visualisierung (dürfte ja bei deinen Kenntnissen kein echtes Problem darstellen) und dann eine detaillierte Erläuterung der einzelnen Schritte so weit, daß man der Logik, die dahinter steckt, eindeutig folgen kann.

Ich würde so etwas (auch im Anhang) intensiv studieren, da es sehr interresant klingt.

Wie deine IHk reagiert, bleibt mir verschlossen, da meine Glaskugel leider zur Reinigung ist (PS: Geb deinen Wohnort und zuständige IHK im Profil an, dann wäre meine Reinigung beendet.)

Link zu diesem Kommentar
Auf anderen Seiten teilen

Dein Kommentar

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung wiederherstellen

  Nur 75 Emojis sind erlaubt.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...