Software aus Sicht der Admins und Entwickler

Richtige Anwendungsdokumentation

| Autor / Redakteur: Thomas Joos / Stephan Augsten

Damit eine möglichst umfassende Dokumentation gelingt, sollten Entwickler und Administratoren zusammen daran arbeiten.
Damit eine möglichst umfassende Dokumentation gelingt, sollten Entwickler und Administratoren zusammen daran arbeiten. (Bild: Štefan Štefančík - Unsplash.com / CC0)

Geht es um die Dokumentation von Anwendungen, sollten Administratoren mit Entwicklern zusammenarbeiten. Neben der Bereitstellung und Verwaltung spielen schließlich auch viele Bereiche aus der Entwicklung eine große Rolle.

Administratoren stellen Anwendungen im Netzwerk bereit und verwalten diese. Entwickler kümmern sich um neue Funktionen und die generelle Programmierung der Anwendungen. Bei Dokumentationen spielen aber beide Bereiche eine sehr wichtige Rolle, da die Entwicklung starken Einfluss auf die Bereitstellung hat, was auch umgekehrt gilt.

Nur wenn beide Bereiche zusammenarbeiten, zum Beispiel auch in DevOps-Umgebungen, bieten Anwendungen die meisten Vorteile. Eine Dokumentation stellt somit keinen Selbstzweck dar, sondern sie sorgt dafür, dass selbstentwickelte Anwendungen bereitgestellt werden können, um Geschäftsprozesse zu organisieren.

Erst wenn Anwendungen nicht nur bestmöglich entwickelt wurde, sondern auch effizient funktionieren und bereitgestellt werden, können Anwender die Geschäftsprozesse mit der Applikation richtig nutzen. Auch hier ist eine gute Dokumentation wichtig. Aus diesem Grund ist die Dokumentation ein wesentlicher Bestandteil für stabil und effektiv zur Verfügung gestellte Geschäftsprozesse.

Konzepte für Software-Dokumentation optimal umsetzen

Die Konzeption einer Dokumentation sowie deren Umsetzung und dauerhafter Pflege spielen eine wichtige Rolle bei der Implementation und Betrieb neuer Anwendungen. Häufig wird eine Dokumentation als notwendiges Übel betrachtet. Allerdings kann eine Dokumentation auch ein sehr wertvolles Hilfsmittel sein, wenn es darum geht, Fragen zu einer Software zu beantworten oder Fehler zu beheben.

Die Qualität der Unternehmensprozesse lässt sich mit einer guten Dokumentation deutlich verbessern, insbesondere wenn alle Funktionen einer Anwendung korrekt dokumentiert sind. Dadurch profitieren nicht nur Entwickler, sondern auch Anwender und die Administratoren.

In einer DevOps-Umgebung hilft eine korrekt umgesetzte Dokumentation nicht nur der Entwicklung, sondern auch IT-Administratoren, Anwendern, Vorgesetzten und den Datenschutzbeauftragten. Dadurch können Anwender die Applikation richtig nutzen – und IT-Administratoren können die Anwendung so bereitstellen, wie Entwickler es geplant haben. Entwickler können durch die Dokumentation Updates und Erweiterungen besser bereitstellen. Dadurch greifen die Prozesse aller beteiligten Anwendungen ineinander und Ressourcen werden nicht verschwendet.

In der Fachliteratur gibt es keine eindeutige Definition des richtigen Aufbaus einer Dokumentation. Auch eindeutige Bezeichnungen fehlen und Fachbegriffe werden oft miteinander vermischt. Hier muss also genau darauf geachtet werden, mit welchen Begriffen die Ersteller einer Dokumentation arbeiten. Generell lässt sich also kein eindeutiger Aufbau empfehlen, sondern die Verantwortlichen im Unternehmen müssen exakt planen, wie die Struktur einer Dokumentation aufgebaut sein soll.

Inhalt und Umfang der Dokumentation festlegen

Bereits vor dem Erstellen einer Dokumentation muss festgelegt werden, welche Bestandteile die Dokumentation umfassen soll. Neben einer reinen Dokumentation der Architektur oder der Software müssen auch Belange der Bereitstellung, Bedienung und verwendeten Verfahren berücksichtigt werden.

In welchem Verhältnis die verschiedenen Bereiche zueinander stehen, muss natürlich vorher definiert werden. Wichtig ist darüber hinaus festzulegen, wer die Zielgruppe der Dokumentation ist, und wer diese Dokumentation schreiben soll. Die wichtigsten Punkte bei der Konzeption einer Dokumentation bestehen also darin, festzulegen, was, warum und wie dokumentiert werden muss.

Neben den Vorgaben, die im Unternehmen für eine Dokumentation herrschen, müssen verschiedene Unternehmen auch auf gesetzliche Rahmenbedingungen achten oder auf Vorgaben, die durch bestimmte Zertifizierungen notwendig sind. Vor allem Banken, Versicherungen oder Finanzdienstleister müssen hier auf einiges achten. Das gilt natürlich auch für Organisationen, in denen in Anwendungen mit persönlichen Daten gearbeitet wird.

Generell kommt bei einer Anwendungsdokumentation auch das „Requirements Engineering“ zum Tragen. Dabei werden alle Eigenschaften einer Software erfasst sowie die Rahmenbedingungen, die über den kompletten Lebenszyklus einer Anwendung gehen. Natürlich muss dabei auch die Dokumentation berücksichtigt werden. Die Anforderungen, die an eine Software gestellt werden, müssen erfasst und in der Dokumentation berücksichtigt werden. Diese spielen zusammen, um Betrieb und den Fachbereich in die Anwendungsentwicklung mit einzubeziehen.

Konforme Dokumentation beachten

Vorgesetzte, Kunden und Autoren der Dokumentation müssen sich also zunächst darüber einig werden, wie die Dokumentation erstellt werden soll. Neben den Anforderungen der Auftragsteller spielt natürlich auch der generelle konforme Aufbau der Dokumentation eine wichtige Rolle.

Abhängig von den gesetzlichen Vorgaben muss die Dokumentation auch sicherstellen, dass Daten einer Anwendung vertraulich behandelt werden, wenn es sich dabei um persönliche Daten von Kunden oder Angestellten handelt. Es muss sichergestellt sein, dass eine Dokumentation alle Vorgaben erfüllt, die durch Gesetze und Vorgaben der Zertifizierungen im Unternehmen gestellt werden.

IT-Dokumentation aus Datenschutzsicht

Verarbeitet die Anwendung persönliche und relevante Daten von Kunden und Mitarbeitern spielt der Datenschutz natürlich eine besonders wichtige Rolle. Auch dieser Sachverhalt muss in der Dokumentation untergebracht werden. Hier kann es sinnvoll sein auf Software zu setzen, die beim Erstellen von Dokumentationen helfen kann.

Bei Dokumentationen können Anwendungen wie Docusnap oder Spiceworks helfen. Wird eine Software zur Dokumentation eingesetzt, wird nicht nur die Erstellung automatisiert, sondern auch die Aktualisierung. Außerdem können spezielle Anwendungen auch die notwendigen Daten zur Dokumentation weitgehend automatisieren.

Unabhängig davon, ob die Dokumentation mit einer Software automatisch oder manuell erstellt wird, muss der Datenschutz berücksichtigt werden. Hier muss auch überprüft werden, ob der Datenschutzbeauftragte die Dokumentation ebenfalls nutzen soll. In diesem Zusammenhang sollte auch festgelegt werden, ob der Datenschutzbeauftragte an der Dokumentation mitarbeiten soll. Durch die Koordination der Dokumentation mit dem Datenschutzbeauftragten, kann dieser zum Beispiel überprüfen, ob Berechtigungen in der Anwendung korrekt gesetzt werden, oder ob die persönlichen Daten sicher gespeichert werden.

Kommentare werden geladen....

Kommentar zu diesem Artikel

Anonym mitdiskutieren oder einloggen Anmelden

Avatar
  1. Avatar
    Avatar
    Bearbeitet von am
    Bearbeitet von am
    1. Avatar
      Avatar
      Bearbeitet von am
      Bearbeitet von am

Kommentare werden geladen....

Kommentar melden

Melden Sie diesen Kommentar, wenn dieser nicht den Richtlinien entspricht.

Kommentar Freigeben

Der untenstehende Text wird an den Kommentator gesendet, falls dieser eine Email-hinterlegt hat.

Freigabe entfernen

Der untenstehende Text wird an den Kommentator gesendet, falls dieser eine Email-hinterlegt hat.

copyright

Dieser Beitrag ist urheberrechtlich geschützt. Sie wollen ihn für Ihre Zwecke verwenden? Infos finden Sie unter www.mycontentfactory.de (ID: 44955810 / Software-Erstellung)