Dokumentationen in der Software-Entwicklung Teil 3

[Teil 1 | Teil 2 | Teil 3 | Teil 4 | Teil 5]

Systemhandbuch

Diese Kategorie von Dokumentation findet sich überwiegend in den Händen von Administratoren, die mit speziellen Rechnersystemen arbeiten. Ein solches Handbuch umfasst sowohl die Dokumentation der Hardware als auch des Betriebssystems.


Texte innerhalb der Software

Viele Texte sind Teil der Software:

• Beschriftungen von Menüheadern im Kopf der Anwendung

• Beschriftung der Menüpunkte selber

• Textzeilen der kontextsensitiven Menüs (rechte Maustaste)

• Tooltips, z.B. kleine Popup-Fenster, die beim Überstreichen eines Buttons,

  eines Bildes usw. mit dem Mauszeiger erscheinen

Einige Anwendungen arbeiten zusätzlich mit der Maus: Online-Wörterbücher mit Tooltipfunktion. Wenn auf das Wort, das nachgeschlagen werden soll, geklickt wird, zeigt das Programm die Wortbedeutungen, manchmal auch die Aussprache.




Bevor und während die Software entwickelt wird, müssen zahlreiche Dokumente erstellt werden. In großen Organisationen ist der zeitliche Aufwand für die Dokumentationserstellung fast so groß wie der für die eigentliche Software-Erstellung.


Anforderungsanalyse

Anforderungen umfassen das Verhalten (funktionale Anforderungen), die Eigenschaften und die Qualitätsmerkmale (nichtfunktionale Anforderungen) eines Systems. Sie werden von Benutzern formuliert, sind Systemeigenschaften oder spezielle Nebenbedingungen.


Ausgehend von einer Analyse des Systemkontextes anhand von Anwendungsfällen (Use Cases) und deren Verfeinerung in Aktivitätsdiagrammen werden die Anforderungen an die zu bauende oder zu ändernde Software identifiziert. Zugleich sind die Anforderungen aus Nutzersicht zusammenzuführen und einzubeziehen.


Use Cases zeigen das externe Verhalten des zu entwickelnden Systems aus Sicht der Nutzer, indem sie die Nutzer, die Anwendungsfälle und deren Beziehung zueinander darstellen, und beschreiben den Auslöser (Akteur) einer Funktion und deren essentielle Schritte. Dadurch werden die zu realisierenden Funktionen auf einem abstrakten Level beschrieben, um die funktionalen Anforderungen grob zu strukturieren und die geforderte Kernfunktionalität zu dokumentieren.


Machbarkeitsstudie

Am Anfang von großen Software-Projekten steht meist eine Machbarkeitsstudie, in der die Ziele des Projekts, seine Realisierbarkeit, die Risiken bei der Umsetzung und nicht zuletzt die voraussichtlichen Kosten eingeschätzt werden. Ein Beispiel für ein solches Projekt war die Einführung eines neuen Vertriebssystems bei der Deutschen Bahn. Hier ging es insbesondere um die Herausarbeitung der Zieltechnologien und die Darstellung der möglichen Migrationspfade. Ist das Vorhaben stark risikobehaftet, wird eine eigene Risikoanalyse vorgenommen, deren Aufgabe darin besteht, anhand von präzisen Systemanalysen vor Ort diejenigen Risiken zu identifizieren, die die Projektumsetzung gefährden.


Die Machbarkeitsstudie ist die erste Vorlage für die Managementebene, die über das Projekt und die Freigabe entsprechender personeller und finanzieller Ressourcen entscheidet.


Lastenheft

Wird das Software-Projekt (öffentlich) ausgeschrieben, ist ein Lastenheft unabdingbar. In ihm sind sämtliche Anforderungen und Bedingungen zur Projektdurchführung formuliert. Wenn der Auftraggeber gut gearbeitet hat, fließen die Resultate des Grobkonzepts in das Lastenheft bereits ein. Das setzt voraus, dass er über eigene personelle Ressourcen verfügt, die diese grundlegende Arbeit leisten können.


Weiter über die Dokumentationen in der Software-Entwicklung Teil 4.

[Teil 1 | Teil 2 | Teil 3 | Teil 4 | Teil 5]
Aufsätze zur Sprache
In einer Fachzeitschrift für gesundes Katzenfutter las ich neulich eine Glosse, die die laxe Einstellung eines Teils der schreibenden Zunft zur Rechtschreibreform widerspiegelt:

"Warum ist die Rechtschreibung reformiert worden? -
Um die Zahl der studierfähigen Abgänger der allgemeinbildenden Schulen erhöhen zu können. Die Rechtschreibreform hat einen Teil der Rechtschreibfehler, die Schüler vorher gemacht haben, zur schriftsprachlichen Norm erhoben und damit wegrationalisiert. Jetzt kann jeder, der weiß, wie man einen Kugelschreiber festhält, das Abitur machen und hinterher Journalist werden. Vorsorglich haben die Zeitungen und Zeitschriften schon mal die RSR bei sich eingeführt. Für hartnäckige Fälle gibt es Jobs in der Politik, zum Beispiel im Kultusministerium, oder beim Institut für Deutsche Sprache oder beim Privatfernsehen."

Die Rechtschreibreform wurde und wird leider von fast allen Schriftstellern und der überwiegenden Mehrheit der Sprachwissenschaftler abgelehnt. Nach neusten Umfragen sollen nur 8% der Befragten sich positiv zur Rechtschreibreform geäußert haben, die meisten Bundesbürger verwenden die alte Rechtschreibung - oder keine.

Siehe auch "Die Rechtschreibreform ist endgültig gescheitert".

Die damalige Präsidentin der Kultusministerkonferenz, Johanna Wanka, sagte 2005 dem Spiegel: „Die Kultusminister wissen längst, dass die Rechtschreibreform falsch war. Aus Gründen der Staatsräson ist sie nicht zurückgenommen worden.“ (Wikipedia, Johanna Wanka)
Dem ist nichts hinzuzufügen. Inzwischen wacht die Deutsche Presseagentur über eine einheitliche Schreibweise in Deutschland, in der Schweiz ist die Schweizer Orthographische Konferenz zuständig, an der auch Sprachwissenschaftler beteiligt sind.