Ob in großen Entwickler-Teams oder bei hoher Mitarbeiterfluktuation – die Quellcode-Dokumentation ist unentbehrliches Werkzeug für die Zusammenarbeit von Programmierern. In vielen Software-Unternehmen wird ihr Potenzial jedoch nicht ausgeschöpft. Daher bietet die Erlanger doctima GmbH ein neues Beratungspaket, das Software-Entwickler ab sofort bei der Verbesserung der Quellcode-Dokumentation unterstützt. „Mit optimierter Quellcode-Dokumentation können Software-Entwickler bis zu 40 Prozent Arbeitszeit einsparen“, sagt Edgar Hellfritsch, Geschäftsführer der doctima GmbH.
Die Quellcode-Dokumentation ist in der Software-Entwicklung Nachschlagewerk für Fehlerbehebung, Weiterentwicklungen und Folgeprojekte. Sie ermöglicht Entwicklern einen Überblick über den Code-Aufbau und macht die Funktionen einzelner Abschnitte schnell nachvollziehbar – nützlich für die Einarbeitung in ältere eigene Projekte oder unbekannte Programmcode von Kollegen. Die Quellcode-Dokumentation wird automatisiert aus fertigem Quellcode und darin enthaltenen Kommentaren der Programmierer abgeleitet. Damit das erzeugte Dokument seinen Zweck als Nachschlagewerk erfüllt, muss der Code vollständig und sinnstiftend kommentiert sein. Für viele Entwickler ist das Kommentieren während des Programmierens jedoch eine lästige Pflicht. Sie vernachlässigen wichtige Angaben zu einzelnen Abschnitten im Quellcode oder formulieren sie unverständlich. Die Folge: Eine solche Dokumentation ist schwieriger nachzuvollziehen als der Code selbst. Wer seine Arbeit also nicht oder unzureichend kommentiert und dokumentiert, raubt sich und anderen Projektbeteiligten viel Zeit. „Viele Entwickler vergessen außerdem, dass sie den fertigen Programmcode komplett mit allen Kommentaren an ihre Kunden ausliefern“, so Edgar Hellfritsch. „Dürftige oder flapsige Erläuterungen schaden der Reputation, saubere Dokumentation dagegen spiegelt Qualitätsarbeit wider.“
Zur Optimierung von Code-Kommentaren und Quellcode-Dokumentation bietet die doctima GmbH jetzt Beratungsmaßnahmen an, die Software-Entwicklern die Schreibarbeit erleichtern. Die Module sind einzeln oder als Gesamtpaket buchbar.
• Reifegrad-Analyse
Welche Qualität haben die vorhandenen Dokumentations-Dateien und der dazugehörige Quellcode? Die doctima-Berater identifizieren Ansatzpunkte zur Optimierung für Entwickler und Nutzer.
• Schreibstandards
Auf Basis der Analyse entwickeln die doctima-Mitarbeiter Vorgaben, die der Quellcode-Dokumentation die gewünschte Textqualität geben. Auf Wunsch werden die Vorgaben als „Styleguide“ aufbereitet, der mit Beispielen und Tipps als Nachschlagewerk dient.
• Schulung
Speziell für Software-Entwickler aufbereitete Schreibtrainings erleichtern den Einstieg in standardisierte Quellcode-Kommentierung.
• Prozessverbesserung mit Werkzeugen
doctima unterstützt interessierte Software-Unternehmen bei der Auswahl und Implementierung von Instrumenten, die standardisierte und automatisierte Erzeugung von Quellcode-Dokumentation erleichtern.
„Jeder Entwickler gewöhnt sich in seiner Laufbahn seine eigene Art und Weise zu programmieren und zu kommentieren an“, weiß Edgar Hellfritsch aus eigener Erfahrung. Mit den Schreibtrainings und praxisnahen Vorlagen von doctima finden sich Programmierer leicht in die Verwendung von Schreibstandards ein. „Unsere Kunden merken schnell, wie sie sich selbst die Arbeit erleichtern, wenn sie zweckmäßig und einheitlich kommentieren. Sie achten automatisch mehr auf die Qualität ihres Codes. Und wenn auch die Kollegen ihre Projekte ordentlich dokumentieren, sparen alle viel Zeit, wenn sie Quellcode nachvollziehen müssen. Nicht selten beobachten wir dann den für unsere Kunden angenehmen Nebeneffekt, dass die Arbeitsmotivation der Entwickler spürbar steigt.“
Die Quellcode-Dokumentation ist in der Software-Entwicklung Nachschlagewerk für Fehlerbehebung, Weiterentwicklungen und Folgeprojekte. Sie ermöglicht Entwicklern einen Überblick über den Code-Aufbau und macht die Funktionen einzelner Abschnitte schnell nachvollziehbar – nützlich für die Einarbeitung in ältere eigene Projekte oder unbekannte Programmcode von Kollegen. Die Quellcode-Dokumentation wird automatisiert aus fertigem Quellcode und darin enthaltenen Kommentaren der Programmierer abgeleitet. Damit das erzeugte Dokument seinen Zweck als Nachschlagewerk erfüllt, muss der Code vollständig und sinnstiftend kommentiert sein. Für viele Entwickler ist das Kommentieren während des Programmierens jedoch eine lästige Pflicht. Sie vernachlässigen wichtige Angaben zu einzelnen Abschnitten im Quellcode oder formulieren sie unverständlich. Die Folge: Eine solche Dokumentation ist schwieriger nachzuvollziehen als der Code selbst. Wer seine Arbeit also nicht oder unzureichend kommentiert und dokumentiert, raubt sich und anderen Projektbeteiligten viel Zeit. „Viele Entwickler vergessen außerdem, dass sie den fertigen Programmcode komplett mit allen Kommentaren an ihre Kunden ausliefern“, so Edgar Hellfritsch. „Dürftige oder flapsige Erläuterungen schaden der Reputation, saubere Dokumentation dagegen spiegelt Qualitätsarbeit wider.“
Zur Optimierung von Code-Kommentaren und Quellcode-Dokumentation bietet die doctima GmbH jetzt Beratungsmaßnahmen an, die Software-Entwicklern die Schreibarbeit erleichtern. Die Module sind einzeln oder als Gesamtpaket buchbar.
• Reifegrad-Analyse
Welche Qualität haben die vorhandenen Dokumentations-Dateien und der dazugehörige Quellcode? Die doctima-Berater identifizieren Ansatzpunkte zur Optimierung für Entwickler und Nutzer.
• Schreibstandards
Auf Basis der Analyse entwickeln die doctima-Mitarbeiter Vorgaben, die der Quellcode-Dokumentation die gewünschte Textqualität geben. Auf Wunsch werden die Vorgaben als „Styleguide“ aufbereitet, der mit Beispielen und Tipps als Nachschlagewerk dient.
• Schulung
Speziell für Software-Entwickler aufbereitete Schreibtrainings erleichtern den Einstieg in standardisierte Quellcode-Kommentierung.
• Prozessverbesserung mit Werkzeugen
doctima unterstützt interessierte Software-Unternehmen bei der Auswahl und Implementierung von Instrumenten, die standardisierte und automatisierte Erzeugung von Quellcode-Dokumentation erleichtern.
„Jeder Entwickler gewöhnt sich in seiner Laufbahn seine eigene Art und Weise zu programmieren und zu kommentieren an“, weiß Edgar Hellfritsch aus eigener Erfahrung. Mit den Schreibtrainings und praxisnahen Vorlagen von doctima finden sich Programmierer leicht in die Verwendung von Schreibstandards ein. „Unsere Kunden merken schnell, wie sie sich selbst die Arbeit erleichtern, wenn sie zweckmäßig und einheitlich kommentieren. Sie achten automatisch mehr auf die Qualität ihres Codes. Und wenn auch die Kollegen ihre Projekte ordentlich dokumentieren, sparen alle viel Zeit, wenn sie Quellcode nachvollziehen müssen. Nicht selten beobachten wir dann den für unsere Kunden angenehmen Nebeneffekt, dass die Arbeitsmotivation der Entwickler spürbar steigt.“
