© best_vector/Shutterstock.com
Windows Developer
Große und komplexe Anwendungen mit Angular umsetzen

Angular dokumentieren

An großen Softwareprojekten arbeiten in der Regel viele Entwickler in mehreren Teams über einen längeren Zeitraum. Daraus ergeben sich einige Herausforderungen. So wird es immer wieder vorkommen, dass bestimmte Eigenschaften einer Softwarelösung nicht allen Entwicklern in jeder Detailstufe bekannt sind. In all diesen Fällen ist es notwendig, dass sie sich schnell und effizient in die bestehende Software einarbeiten können.

Karsten Sitterberg


Auch wenn ein mit dem Projekt vertrauter Entwickler nach längerer Abwesenheitszeit wieder in ein Softwareprojekt einsteigt, wird er eine gewisse Zeit benötigen, um sich erneut in die Software einzufinden. Um andere Entwickler und auch sich selbst besser bei dieser (Wieder-)Einfindungsphase zu unterstützen, sollte daher jeder Entwickler parallel zur Software eine ausführliche Dokumentation anlegen und auch pflegen.

Sorgfältig dokumentieren

Eine aussagekräftige Dokumentation zeichnet sich in erster Linie dadurch aus, dass sie leicht auffindbar ist. Sie muss außerdem aktuell sein und zur jeweiligen Version der Software passen – schlimmer als keine Dokumentation zu besitzen, ist es, nur eine veraltete Dokumentation zur Verfügung zu haben. Der Entwicklungsprozess sollte daher neben dem Quellcode auch die zu erzeugende Dokumentation berücksichtigen. Das bedeutet einerseits, dass immer eine Liveversion der Dokumentation zur Entwicklungszeit in Form von Doc-Kommentaren zur Verfügung stehen sollte. So kann die Dokumentation von IDEs ausgewertet werden, um sie dem Entwickler zu gegebener Zeit anzuzeigen. Andererseits sollte eine Version der Dokumentation – sinnvollerweise die, die dem momentan in Produktion befindlichen Softwarestand entspricht – an zentraler Stelle, zum Beispiel in Form einer Webseite, bereitgestellt werden. In agilen Entwicklungsprozessen erweist es sich darüber hinaus als sinnvoll, die vollständige Dokumentation der Software in die „Definition of Done“ für einen Sprint aufzunehmen und gleichzeitig festzulegen, was „vollständig“ bedeutet.

Softwaredokumentation lässt sich auf unterschiedliche Weise erzeugen, beispielsweise mithilfe von Wiki-Einträgen oder anderen externen Werkzeugen, oder als automatisch aus dem Code generiertes Dokument. Um die optimale Art von Dokumentation für ein Projekt zu bestimmen, sollte der Entwickler die gegebenen Rahmenbedingungen berücksichtigen.

In großen, agil vorgehenden Teams beispielsweise ändert sich der Code in den meisten Fällen parallel auf verschiedenen Entwicklungszweigen. Entsprechend schnell und nebenläufig muss die Dokumentation hier aktualisierbar sein und den Zustand auf den verschiedenen Zweigen widerspiegeln. Mit Wiki-Systemen lässt sich das zum Beispiel nur schwer abbilden. Auch mit externen Tools erstellte Dokumente, wie zum Beispiel Word-Dokumente, schaffen hier keine Abhilfe. Allein das Zusammenführen von Dokumenten aus verschiedenen Entwicklungsständen oder Entwicklungszweigen ist in der Regel nur ...

Windows Developer
Große und komplexe Anwendungen mit Angular umsetzen

Angular dokumentieren

An großen Softwareprojekten arbeiten in der Regel viele Entwickler in mehreren Teams über einen längeren Zeitraum. Daraus ergeben sich einige Herausforderungen. So wird es immer wieder vorkommen, dass bestimmte Eigenschaften einer Softwarelösung nicht allen Entwicklern in jeder Detailstufe bekannt sind. In all diesen Fällen ist es notwendig, dass sie sich schnell und effizient in die bestehende Software einarbeiten können.

Karsten Sitterberg


Auch wenn ein mit dem Projekt vertrauter Entwickler nach längerer Abwesenheitszeit wieder in ein Softwareprojekt einsteigt, wird er eine gewisse Zeit benötigen, um sich erneut in die Software einzufinden. Um andere Entwickler und auch sich selbst besser bei dieser (Wieder-)Einfindungsphase zu unterstützen, sollte daher jeder Entwickler parallel zur Software eine ausführliche Dokumentation anlegen und auch pflegen.

Sorgfältig dokumentieren

Eine aussagekräftige Dokumentation zeichnet sich in erster Linie dadurch aus, dass sie leicht auffindbar ist. Sie muss außerdem aktuell sein und zur jeweiligen Version der Software passen – schlimmer als keine Dokumentation zu besitzen, ist es, nur eine veraltete Dokumentation zur Verfügung zu haben. Der Entwicklungsprozess sollte daher neben dem Quellcode auch die zu erzeugende Dokumentation berücksichtigen. Das bedeutet einerseits, dass immer eine Liveversion der Dokumentation zur Entwicklungszeit in Form von Doc-Kommentaren zur Verfügung stehen sollte. So kann die Dokumentation von IDEs ausgewertet werden, um sie dem Entwickler zu gegebener Zeit anzuzeigen. Andererseits sollte eine Version der Dokumentation – sinnvollerweise die, die dem momentan in Produktion befindlichen Softwarestand entspricht – an zentraler Stelle, zum Beispiel in Form einer Webseite, bereitgestellt werden. In agilen Entwicklungsprozessen erweist es sich darüber hinaus als sinnvoll, die vollständige Dokumentation der Software in die „Definition of Done“ für einen Sprint aufzunehmen und gleichzeitig festzulegen, was „vollständig“ bedeutet.

Softwaredokumentation lässt sich auf unterschiedliche Weise erzeugen, beispielsweise mithilfe von Wiki-Einträgen oder anderen externen Werkzeugen, oder als automatisch aus dem Code generiertes Dokument. Um die optimale Art von Dokumentation für ein Projekt zu bestimmen, sollte der Entwickler die gegebenen Rahmenbedingungen berücksichtigen.

In großen, agil vorgehenden Teams beispielsweise ändert sich der Code in den meisten Fällen parallel auf verschiedenen Entwicklungszweigen. Entsprechend schnell und nebenläufig muss die Dokumentation hier aktualisierbar sein und den Zustand auf den verschiedenen Zweigen widerspiegeln. Mit Wiki-Systemen lässt sich das zum Beispiel nur schwer abbilden. Auch mit externen Tools erstellte Dokumente, wie zum Beispiel Word-Dokumente, schaffen hier keine Abhilfe. Allein das Zusammenführen von Dokumenten aus verschiedenen Entwicklungsständen oder Entwicklungszweigen ist in der Regel nur ...

Neugierig geworden?


   
Loading...

Angebote für Teams

Für Firmen haben wir individuelle Teamlizenzen. Wir erstellen Ihnen gerne ein passendes Angebot.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang