Definition „Software-Dokumentation“

Was ist eine Softwaredokumentation?

| Autor / Redakteur: zeroshope / Stephan Augsten

Eine Software-Dokumentation kann aufgrund der unterschiedlichen Zielgruppen sehr kleinteilig und umfangreich werden.
Eine Software-Dokumentation kann aufgrund der unterschiedlichen Zielgruppen sehr kleinteilig und umfangreich werden. (Bild: UliSchu - Pixabay.com / CC0)

Die Software-Dokumentation hat die Aufgabe, digitale Prozesse verständlich zu erläutern. Anwendungen sollen möglichst umfassend und einfach erklärt werden. Da es verschiedene Zielgruppen gibt, fällt die Dokumentation in der Regel umfangreich aus.

Eine Software-Dokumentation wird von den Entwicklern der jeweiligen Anwendung geschrieben. Sie soll als Bedienungsanleitung für jeden Nutzer dienen. Grundsätzlich sollen deshalb drei Fragen im Rahmen der Dokumentation behandelt werden:

  • 1. Wie funktioniert die Software?
  • 2. Wie wird die Anwendung bedient?
  • 3. Wie wurde das Programm entwickelt?

Durch die Antworten auf diese Fragen soll den unterschiedlichen Zielgruppen Rechnung getragen werden, die mit der Software arbeiten. Vom Einkäufer eines Unternehmens über den Programmierer bis zum privaten Endnutzer soll jeder User die Informationen finden, die er benötigt. Oberflächlich lässt sich im Rahmen der Software-Dokumentation deshalb wie folgt differenzieren:

  • Systemdokumentation: Die Funktionen der Software werden erklärt. Zudem wird die Bedienung der Anwendung erläutert.
  • Projektdokumentation: Die Programmierer beschreiben die vollständige Entwicklung des jeweiligen Programms (Was? Wann? Womit? Wie? Weshalb?).

Aufbau einer Software-Dokumentation

Die oberflächliche Unterscheidung dient aber nur dazu, um eine Dokumentation ohne Schwierigkeit lesen zu können. Nutzer sollen schnell und einfach die für sie relevanten Informationen finden. Wer eine Software-Dokumentation schreiben möchte, muss einen wesentlich kleinteiligeren Aufbau wählen. Folgende Gliederung hat sich als Standard bewährt:

  • Dokumentation der Methoden: Auf welchen Grundlagen basiert die Software?
  • Dokumentation der Programmierung: Was ist beim Quellcode relevant?
  • Dokumentation der Installation: Welche Hardware und Software ist erforderlich, um das Programm nutzen zu können?

Diese drei Punkte werden in den Projektdokumenten niedergelegt. Die folgenden vier Punkte sind Teil der Systemdokumente:

  • Dokumentation für den Gebrauch: Wie funktioniert die Software? Welche Funktionen hat sie und wie wird sie benutzt?
  • Dokumentation über die Daten: Was ist bezüglich der inneren und der äußeren Datenstruktur zu berücksichtigen?
  • Dokumentation über Tests/ Prüfungen: Welche Tests hat die Software durchlaufen, die bezeugen, dass die Anwendung wirklich beherrscht, was sie verspricht?
  • Dokumentation über die Weiterentwicklung: Die Software-Dokumentation endet erst dann, wenn die Unterstützung für ein Programm eingestellt wird. Bis dahin müssen alle Weiterentwicklungen detailliert nach den unterschiedlichen Versionen festgehalten werden.

Die schwierigste Aufgabe: Zielgruppengerecht schreiben

Die komplizierteste Aufgabe beim Verfassen der Software-Dokumentation ist das Treffen des richtigen Tons für die jeweilige Zielgruppe. Dies gilt insbesondere für die Systemdokumentation. Diese Texte werden gleichermaßen von Systemadministratoren, Programmierern wie auch von Endnutzern ohne jede Vorbildung gelesen. Es kann Sinn machen, deshalb im Rahmen der Systemdokumente nochmals zu differenzieren. Dabei wird nach professionellen Usern sowie privaten Endnutzern differenziert.

Für professionelle Nutzer ist dabei deren Stellenbeschreibung zu berücksichtigen. Was genau tun sie und wofür werden sie die Software vermutlich benötigen? Es ist auch sinnvoll, mit den Anwendern zu sprechen, um auf diese Weise wertvolle Rückmeldungen zu erhalten.

Ein Sonderfall: Die Software-Dokumentation für das Marketing

Bei vielen neuen Anwendungen wird die Software-Dokumentation auch für das Marketing genutzt. Insbesondere bei solchen Programmen, die private Anwender einsetzen sollen, ist Fachsprache deshalb unerwünscht. In einem solchen Fall muss eine „Reinschrift“ der Systemdokumente erstellt werden, die ohne Fachvokabular auskommt.

Kommentare werden geladen....

Kommentar zu diesem Artikel

Der Kommentar wird durch einen Redakteur geprüft und in Kürze freigeschaltet.

Anonym mitdiskutieren oder einloggen Anmelden

Avatar
Zur Wahrung unserer Interessen speichern wir zusätzlich zu den o.g. Informationen die IP-Adresse. Dies dient ausschließlich dem Zweck, dass Sie als Urheber des Kommentars identifiziert werden können. Rechtliche Grundlage ist die Wahrung berechtigter Interessen gem. Art 6 Abs 1 lit. f) DSGVO.
  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.

Aktuelle Beiträge zu diesem Thema

Richtige Anwendungsdokumentation

Software aus Sicht der Admins und Entwickler

Richtige Anwendungsdokumentation

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. lesen

Was ist Programmierung?

Definition „Programmieren“

Was ist Programmierung?

Unter dem Begriff Programmieren versteht man die Umsetzung von Software-Entwürfen. Welche Programmiersprache zum Einsatz kommt, hängt von der jeweiligen Aufgabe ab. Gutes Programmieren zeichnet sich stets durch das Einhalten bestimmter Qualitätskriterien aus. lesen

copyright

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