2. Welche Aufgaben hat ein Autorenfrontend?

2.1 Unterstützung in der Dokumentenverwaltung

Das Frontend ist auch für die Verwaltung der Dokumente verantwortlich, es muß gewährleisten das Dokumente mit Zeit- , Versionsstempeln versehen werden und das der Name des Autoren gespeichert wird. Das Dokument muß durch den Autoren ,oder besser durch das Frontend, in das entsprechende Projekt bzw. in die Ablagestruktur eingefügt werden. Den Überblick über die Dokumente erhält man, indem das Frontend entweder selbst, oder durch ein anderes Tool, die Struktur zur anzeige bringt.

Weiterhin sollte der Fortschritt in der Dokumentation, entsprechend des gewählten Vorgehensmodell, angezeigt werden.

 

2.2 Hilfe bei der Dokumenten Erstellung.

Das schwierigste bei der Softwaredokumentation ist das einhalten von Normen, wie z.B. die ISO9000ff, hierbei kann das Frontend Hilfen bieten. Das Anzeigen von Vorgehensweisen oder sogar Mustern, für das jeweilige Dokument in der entsprechenden Norm, vereinfacht es dem Autoren den richtigen Stil und den Erhalt der Norm zu gewährleisten. Dadurch ist es dem Autoren möglich in geringerer Zeit das Dokument zu erstellen und schneller die nächste Phase der Entwicklung zu erreichen.

Es mag zwar aufwendig und schwer sein solche Muster zu erstellen, aber wie bei den Entwurfsmustern in der Programmentwicklung, kann so Expertenwissen einfacher übermittelt werden. Da die Normen an denen sich der Autor Orientieren muß International einheitlich sind, werden solche Muster auch anderswo Entwickelt.

 

2.3 Importmöglichkeiten für Objekte aus Entwicklungswerkzeugen

Wie schon erwähnt erfolgt die Entwicklung von Software meist mit Werkzeugen.Solche Werkzeuge sind so aufgebaut das sie es erlauben schnell einen Überblick über das Entwurfsproblem zu erhalten. Dies bewerkstelligen sie meist mit Diagrammen die viel mehr Aussagekraft haben als Text. Daher ist es notwendig, daß auch Autorenfrontends solche Diagramme in den Text einbauen können. Zusätzlich dazu wäre es gut, wenn sie auch die dazugehörigen Attribute, Beschreibungen und Kommentare aus solchen Diagrammen in den Text übernehmen können. Da teilweise solche Diagramme auch von bestimmte Vorgehensmodelle bzw. Normen in der Dokumentation verlangt werden, ist dies eine einfache Möglichkeit dem nachzukommen.

Die einfachste Möglichkeiten zur Einbettung dieser Objekt ist wahrscheinlich das "Copy and Paste" Verfahren, allerdings bietet dieses nicht die Möglichkeit zum Einfügen der Kommentare und anderen Beschreibungen aus dem Entwicklungswerkzeug und ist daher nur bedingt geeignet.

Eine weitere Methode liegt in der Anbindung über Importfilter, dieses ermöglicht auch die Nachbearbeitung mit dem entsprechenden Werkzeug und das Einfügen der Kommentare und ist damit vorzuziehen.

 

2.4 Möglichkeiten zur Einbettung von Dokumenten aus alten Dokumentationen (Wiederverwendung)

Bei Softwareentwicklung treten häufig ähnliche Probleme bei verschiedenen Projekten auf. Diese Probleme werden heutzutage oftmals über Entwurfsmuster oder Frameworks gelöst und dieses kann man sich auch für die Softwaredokumentation nutzbar machen. Ist ein solches Entwurfsmuster oder ein Framework dokumentiert, kann man diese Dokumentation leicht abgewandelt übernehmen.

Manchmal werden sogar ganze Programmteile aus alten Projekten wiederverwendet und somit währe es von großem nutzen, wenn auf deren Dokumentation zugegriffen werden kann.

INDEX