Das Wissensportal für IT-Professionals. Entdecke die Tiefe und Breite unseres IT-Contents in exklusiven Themenchannels und Magazinmarken.

heise conferences GmbH

(vormals SIGS DATACOM GmbH)

Lindlaustraße 2c, 53842 Troisdorf

Tel: +49 (0)2241/2341-100

kundenservice@sigs-datacom.de

Skalierbare Dokumentation-as-Code im Enterprise-Umfeld

Dokumentationen sind in professionellen Softwareprojekten Pflicht, auch wenn das Erstellen und die Pflege oftmals als lästig empfunden werden. Dieser Artikel stellt verschiedene Werkzeuge vor. Zwei Werkzeuge zeigen beispielhaft auf, wie Dokumentation modular erstellt und der gewünschte Schreibstil eingehalten werden kann.

Die Dokumentation von Software ist komplex. Eine aktuelle und korrekte Dokumentation ist essenziell, damit Nutzer dem Produkt vertrauen. Sie muss ansprechend aussehen, gut strukturiert sein und sich einfach navigieren lassen. Sie muss nicht nur professionell und zielgruppengerecht sein, sondern auch mit dem schnellen Wachstum von Softwareprodukten und den Beiträgen mehrerer Teams Schritt halten. In einer zentralen Dokumentation verliert man schnell den Überblick, während dezentrale Ansätze oft …