Dokumentation Programmierung

Doku-Programmierung

Verfahren; die Methodendokumentation bezieht sich jedoch nicht auf technische Details der Programmierung, die sich häufiger ändern können. Vor allem aber auf die Dokumentation der Programmierung. und wie die eigentliche Programmierung dokumentiert wird. Vor allem, weil C++ eine sehr mächtige und flexible Sprache ist, ist eine aussagekräftige Dokumentation des Codes wichtig.

Es wird eine API-Dokumentation (Application Programming Interface) verwendet.

Weshalb es notwendig ist, Software-Dokumentation zu erstellen?

Die Ursache dafür ist meist nicht der Programmiercode selbst, sondern die fehlende Dokumentation der Software. Oftmals hat derjenige, der die neue Aufgabenstellung annehmen soll, kein reales Bedürfnis, den Quellcode des vorherigen Herstellers zu lernen. Die Unternehmensleitung erachtet es als zwecklos, dass der Programmer mehrere Monaten damit beschÃ?ftigt ist, sich mit der Programmierung vertraut zu machen.

Oft wird die Wahl getroffen, alles von Grund auf zu umprogrammieren. Durch eine gute Dokumentation kann dieser Arbeitsaufwand entfallen. In dem Artikel finden Sie einige Hinweise, warum Dokumentation für die Weiterentwicklung so bedeutsam ist und wie man sie anpackt. In den meisten Fällen werden die folgenden Abschnitte weggelassen: Die Beseitigung dieser Probleme führt zu einer sehr schnellen, aber kaum erweiterbaren Problemlösung.

Was viele nicht erwarten, ist, dass der an der Anlage arbeitende Programmer nicht für immer in der Firma bleiben wird. Schon beim Ausscheiden des Mitarbeiters aus dem Betrieb stehen Sie vor einer großen Aufgabe. Auf der einen Seite wollen Sie verhindern, dass bestehende oder neue Software-Entwickler zu lange an vorhandenen Beispielen forschen und auf der anderen Seite wollen Sie, dass diese so rasch wie möglich leistungsfähig sind.

Dabei wird die Produktivitätssteigerung oft daran bemessen, wie viele Codezeilen erzeugt werden.... und wenn sich der Programmierer an ein vorhandenes Gesamtsystem gewöhnt, gibt es in den ersten paar Schwangerschaftswochen und in den ersten Lebensmonaten in der Applikation meist gar keine neue Linie. Dem mit der Aufgabenstellung betrauten Neuentwickler ist es in den meisten FÃ?llen nicht wirklich wichtig, das "Durcheinander" der Programmierung seines VorgÃ?ngers in den Griff zu bekommen.

Natürlich will die Geschäftsleitung den Arbeitnehmer nicht abschrecken und engagiert sich in der Regel. Dabei hat man bereits die Tätigkeit des Nachfolgers ganz aufgeben. Häufig sind dabei mehrere Wochen und teilweise mehrere Jahre Arbeitsaufwand erforderlich. Im Rahmen der Produktentstehung geht es in der Regel darum, Software-Pakete zu entwickeln, die verschiedenen Anwendern in der selben Weise zur Verfügung gestellt werden.

Bei diesen Produktprojekten bleibt in der Regel viel Zeit für die Entwicklung und Bearbeitung der Simulationssoftware. Bei solchen Beispielen sollten Sie immer auf eine sehr präzise Dokumentation achten und darauf achten, dass diese angelegt wird. Die folgenden Abschnitte können Teil dieser Dokumentation sein: Darüber hinaus gibt es viele andere Belege, die angelegt werden können.

Auf welche Weise wurden frühere Probleme im Gesamtsystem gelöst? Bei der Montage: Wie installiere ich das Gerät? In der Regel wird nur ein kleiner Teil dieser Information geschrieben, denn auch bei der Erarbeitung von Produktlösungen ist die Zeit begrenzt. In serviceorientierten Beispielen, in denen es sehr rasch gehen muss, wird oft nur die Kommentierung des Codes durchgeführt.

Dies kann auch künftigen Mitarbeitern oder fremden Programmieren bei ihrer weiterentwicklung helfen. Neben all dieser Dokumentation gibt es in der Regel auch die Spezifikationen, E-Mails aus der Kundenkommunikation, etc. Mit diesen Angaben wird das Ganze abgerundet und das Entwicklungsteam, das die Leitung der Produktion übernommen hat, hat es leichter, sich mit dem Gesamtsystem vertraut zu machen.

Fühlen Sie sich 50 bis 70 prozentig (nicht auf der Grundlage von Statistiken) der Programmierung wird in einem kurzen Zeitabschnitt von wenigen Jahren auslaufen. Denn es ist nicht mehr möglich, sich mit dem Vorhaben für eine neue Persönlichkeit vertraut zu machen. Ein erfolgreiches Softwareprojekt basiert daher immer auf einer sorgfältigen Programmierung und deren Darstellung.

Selbst erfahrene IT-Unternehmer kommen überraschend ohne Kommentare zum Code aus, meist aus Zeitgründen.

Mehr zum Thema