Technische Dokumentation von Software Systemen mittels domänenspezifischer Sprache

Die Erstellung und Pflege der technischen Dokumentation von Software Systemen ist für die Wartung unabdingbar. Die konventionellen Mittel dazu stossen in der Praxis aber an ihre Grenzen. Diese Bachelor Thesis beschreibt einen alternativen Ansatz.

Gex, Claude, 2012

Art der Arbeit Bachelor Thesis
Auftraggebende Trivadis AG
Betreuende Dozierende Richards, Bradley
Keywords Technische Dokumentation, Software Systeme, Applikationen, Metamodell, Domänenspezifische Sprache, Domain Specific Language, DSL, Sichten, Views, Building Block, Stereotype, Stoa, Xtext, EMF, Eclipse, Plugins, SVG, HTML5
Views: 11 - Downloads: 1
Die Erstellung und Pflege der technischen Dokumentation von Software Systemen mit gängiger Modellierungs- und Textverarbeitungssoftware ist mit verschiedenen Problemen behaftet, welche die Qualität und Aktualität der Dokumentation sowie die Kosten für deren Erstellung und Pflege beeinflussen. Die eingesetzten Dokumentformate sind dabei selten textbasiert, was die Versionierbarkeit und insbesondere die Nachverfolgung von Änderungen beeinträchtigt. Die Orientierung an Dokumenten führt zu Redundanz, wenn verschiedene Sichten auf ein System ermöglicht werden sollen.
In der Analyse werden Rechercheergebnisse nach vergleichbaren Ansätzen, Technologien und Metamodellen ausgewertet. Die Formulierung der Anforderungen schliesst die Analyse ab. Das Metamodell wird im darauffolgenden Konzept modelliert. Ebenso wird die domänenspezifische Sprache (DSL) entworfen, die "Building Block View" definiert und Aspekte der Erweiterungsfähigkeit des Stoa Systems behandelt. Ausgehend vom Konzept wird die Lösung implementiert und bereitgestellt. Mit der Dokumentation eines Software Systems als Fallbeispiel wird Anwendbarkeit demonstriert.
Die Bachelor Thesis zeigt auf, wie Software Systeme mit einer DSL beschrieben werden können, um am Ende daraus Dokumentationsartefakte zu erstellen. Das konzipierte Metamodell erlaubt die Abbildung der wesentlichen Aspekte eines Software Systems und bietet einen gewissen Grad an Flexibilität hinsichtlich systemspezifischen Stereotypen und Attributen. Die Möglichkeit, aus dem Stoa Code in Eclipse oder per Standalone Ausführung verschiedene Sichten mit Diagrammen generieren zu können, ohne dass dazu manuell grafische Elemente positioniert werden müssen, zeigt das Potential des Stoa Systems auf. Verändert sich das zu dokumentierende System, so können die Änderungen im Stoa Code mit verhältnismässig wenig Aufwand nachgezogen werden. Die Dokumentationsartefakte sind durch die Generierung in wenigen Sekunden aktualisiert. Die Lösung ist vollständig mitsamt einem Generator implementiert und steht der Trivadis als Grundlage zur Verwendung und Weiterentwicklung zur Verfügung.
Studiengang: Wirtschaftsinformatik (Bachelor)
Vertraulichkeit: öffentlich
Art der Arbeit
Bachelor Thesis
Auftraggebende
Trivadis AG, Bern
Autorinnen und Autoren
Gex, Claude
Betreuende Dozierende
Richards, Bradley
Publikationsjahr
2012
Sprache der Arbeit
Deutsch
Vertraulichkeit
öffentlich
Studiengang
Wirtschaftsinformatik (Bachelor)
Standort Studiengang
Olten
Keywords
Technische Dokumentation, Software Systeme, Applikationen, Metamodell, Domänenspezifische Sprache, Domain Specific Language, DSL, Sichten, Views, Building Block, Stereotype, Stoa, Xtext, EMF, Eclipse, Plugins, SVG, HTML5