Software Dokumentation Tools

Tools zur Software-Dokumentation

einheitlich und professionell. Erstellung Ihrer Software-Dokumentation auf Tastendruck Für seine Tätigkeit benötigt jeder Entwickler eine verlässliche Software-Dokumentation. Bei den meisten Softwareentwicklern wird an mehreren Projekten gleichzeitig gearbeitet. Deshalb ist es besonders auf eine gute Software-Dokumentation zu achten, um alle Entwicklungsschritte der einzelnen Produkte verfolgen zu können. Eine gute Software-Dokumentation unterstützt auch die spätere Pflege und Weiterführung der Software.

Ich habe als Software-Entwickler oft erlebt, dass viele Entwickler wissen, dass eine klare und komplette Software-Dokumentation notwendig ist, aber für viele ist das Topic ein irritierendes Wort. Gerade in geregelten Umgebungen (z.B. Pharma, Medizintechnik) ist eine durchgängige Dokumentation aller eigenen Entwicklungen eine grundlegende Voraussetzung für den Go-Live. Aber nicht nur deshalb sollte ein Betrieb an einer geeigneten Software-Dokumentation interessiert sein.

Weshalb ist Software-Dokumentation überhaupt notwendig? Die IT-Compliance und Auditoren haben hohe Ansprüche an die Software-Dokumentation. IT-Manager sollten auch ein großes Eigeninteresse an der richtigen und lückenlosen Dokumentation von Eigenentwicklungen haben. Software-Dokumentation: interne oder externe? In SAP gibt es die Option, DDIC-Objekte unmittelbar im Unternehmen zu erfassen, was in der Realität jedoch wenig genutzt wird.

Denn diese Vorgehensweise erlaubt nur die so genannte innerbetriebliche Software-Dokumentation, so dass zusätzliche externe Systemdokumentation, z.B. in Microsoft Word, benötigt wird, so dass alle entscheidungsrelevanten Daten an einer zentralen Position vorzufinden sind. Bei den meisten der von mir befragten Programmierern ist es verständlich, dass sie vor dieser doppelten Anstrengung zurückschrecken. Deshalb wird in der Praxis in der Praxis entweder nur in SAP oder nur in einem fremden Beleg - oder im Extremfall gar nicht - dokumentiert.

Ist es nicht ohne Software-Dokumentation möglich? Beachten Sie, dass ein Mangel an Software-Dokumentation ein großes Risiko für Ihr Geschäft darstellen kann. Dabei geht es um die einfache Wartung, Qualitätssicherung und Fortentwicklung der Software, ganz zu schweigen von dem am Beginn dieses Artikels genannten Know-how-Transfer, der ohne Software-Dokumentation sehr aufwendig wird.

Mit einer Software-Dokumentation können Ihre Entwickler nicht alle Schritte der Entwicklung im Blick haben. Weshalb interner UND externer Dokumentation? Wenn es für eine neue Software überhaupt keine Software-Dokumentation gibt, ist es nur mit sehr großem Zeitaufwand möglich, dass sich ein Dritter mit den fachlichen Aspekten und der Programmlogik vertraut macht. Wer nun die verfahrenstechnischen Secrets des Programmes nachvollziehen will, kann dies nur durch ein aufwändiges "Reverse Engineering" tun, d.h. den Versuchs, die Korrelationen durch Analysieren der Codierung abzuleiten.

Ein externer (z.B. Auditor) kann sich bei einer reinen systeminternen Dokumentation nur schwer einen schnellen Einblick in die Komponenten des Programmes und dessen Dokumentation zulegen. Aus diesem Grund ist in der Praxis in der Praxis ein zentrales vorhandenes Fremddokument erforderlich. Wenn nur systemexterne Dokumentation verwendet wird, gibt ein Worddokument einen besseren Einblick und kann eine schnelle Einführung in das Verstehen eines Programm-/Programmteils sein.

Dennoch ist die Dokumentation innerhalb des Unternehmens sehr hilfreich, insbesondere bei der Auswertung des Codes. Meines Erachtens wäre das Idealszenario eine interne Systemdokumentation, die zudem in einem internen Fremddokument geschrieben wird. Wie wäre es, wenn die Software-Dokumentation automatisiert erzeugt werden könnte? Mit dem von mir und meinem Kollege Jörg Hofmann gemeinsam erarbeiteten SAP ABAP Documentation Generator.

Damit können Sie die Erstellung der technischen Dokumentation für SAP Data Warehouse ABAP/ABAP-OO Entwicklungen automatisiert durchführen. Falls Sie mit dem Dokumentations-Generator zusammenarbeiten, spezifizieren Sie zunächst ein vollständiges Anwendungspaket, einen Beförderungsauftrag oder Einzelobjekte. In der Regel benötigen Sie ein bis zwei Tage, um eine solche Dokumentation für komplexe Projekte manuell zu erfassen. Mit dem Dokumentations-Generator wird diese Aufgabenstellung in wenigen Augenblicken gelöst.

Haben Sie die Dokumente mit Langtexten in SAP selbst erfasst, kann diese Dokumentation auch an Word übergeben werden. So müssen Sie nur einmalig, d. h. unmittelbar im SAP-System erfassen und ersparen sich viel Zeit. Der Dokumentations-Generator erzeugt die fremde fachliche Dokumentation auf Tastendruck. Dadurch wird auch sichergestellt, dass die internen und externen Unterlagen immer aktuell und standortunabhängig sind.

Möchtest du mehr über den Dokumentations-Generator und seine Einsatzmöglichkeiten wissen?

Auch interessant

Mehr zum Thema