Ein Dashboard für die dynamische Dokumentation microservice-basierter Softwaresysteme

Peter Aichinger

Ein Dashboard für die dynamische Dokumentation microservice-basierter Softwaresysteme

Peter Aichinger

Institute of Business Informatics - Software Engineering

Research output: Thesis › Master's / Diploma thesis

Abstract

The documentation of dynamic software systems like the microservice-based architecture is very difficult, because there are different stakeholders with various views, which have to be taken into account. Additionally, the documentation of a complete system is distributed across different system components. Because of that, it is necessary to automate the documentation of such dynamic software systems. This master thesis deals with the implementation of a tool, which keeps the documentation of a microservice-based software systems automatically up-to-date, and makes it possible to integrate information from external systems. At the beginning of this thesis, basic concepts of software architecture and software architecture documentation area are discussed. After that, the requirements for the documentation tool are defined. These requirements were determined using a literature research and a survey. Finally, the implemented dashboard for the documentation of microservice-based software systems is described.

Original language	German (Austria)
Supervisors/Reviewers	Weinreich, Rainer, Supervisor
Publication status	Published - Jan 2017

Fields of science

202005 Computer architecture
202017 Embedded systems
102 Computer Sciences
102002 Augmented reality
102006 Computer supported cooperative work (CSCW)
102011 Formal languages
102015 Information systems
102020 Medical informatics
102022 Software development
102027 Web engineering
201305 Traffic engineering
202022 Information technology
207409 Navigation systems
502032 Quality management
502050 Business informatics

JKU Focus areas

Computation in Informatics and Mathematics
Management and Innovation

Cite this

@mastersthesis{87c20d0b2a794d87842679678194d6e8,

title = "Ein Dashboard f{\"u}r die dynamische Dokumentation microservice-basierter Softwaresysteme",

abstract = "Die Dokumentation dynamischer Softwaresysteme, wie jene welche eine microservice-basierte Architektur verfolgen, ist komplex. Vor allem die Notwendigkeit der Ber{\"u}cksichtigung unterschiedlicher Stakeholder mit verschiedenen Sichten und der Umstand, dass die ben{\"o}tigten Informationen {\"u}ber verschiedenen Systeme verteilt sind, tragen dazu bei. Die sich laufend {\"a}ndernde Architektur dieser Systeme machen eine manuelle Dokumentation des Systems zeitund somit auch kostenintensiv. Aus diesem Grund ist es notwendig, die Dokumentation dynamischer Systeme zu automatisieren. Diese Arbeit besch{\"a}ftigt sich mit der Umsetzung eines Dashboards, welches die Dokumentation aktuell h{\"a}lt und in welchem es m{\"o}glich ist, Informationen aus unterschiedlichen Systemen zu integrieren. Zu Beginn der Arbeit werden grundlegende Begriffe aus den Bereichen Softwarearchitektur und Architekturdokumentation diskutiert. Anschlie{\ss}end werden Anforderungen an das Dashboard definiert, welche aus vorhandener Literatur und einer Umfrage abgeleitet wurden. Schlie{\ss}lich wird das implementierte Dashboard f{\"u}r die Dokumentation von microservice-basierten Softwarearchitekturen vorgestellt.",

author = "Peter Aichinger",

year = "2017",

month = jan,

language = "Deutsch ({\"O}sterreich)",

}

TY - THES

T1 - Ein Dashboard für die dynamische Dokumentation microservice-basierter Softwaresysteme

AU - Aichinger, Peter

PY - 2017/1

Y1 - 2017/1

N2 - Die Dokumentation dynamischer Softwaresysteme, wie jene welche eine microservice-basierte Architektur verfolgen, ist komplex. Vor allem die Notwendigkeit der Berücksichtigung unterschiedlicher Stakeholder mit verschiedenen Sichten und der Umstand, dass die benötigten Informationen über verschiedenen Systeme verteilt sind, tragen dazu bei. Die sich laufend ändernde Architektur dieser Systeme machen eine manuelle Dokumentation des Systems zeitund somit auch kostenintensiv. Aus diesem Grund ist es notwendig, die Dokumentation dynamischer Systeme zu automatisieren. Diese Arbeit beschäftigt sich mit der Umsetzung eines Dashboards, welches die Dokumentation aktuell hält und in welchem es möglich ist, Informationen aus unterschiedlichen Systemen zu integrieren. Zu Beginn der Arbeit werden grundlegende Begriffe aus den Bereichen Softwarearchitektur und Architekturdokumentation diskutiert. Anschließend werden Anforderungen an das Dashboard definiert, welche aus vorhandener Literatur und einer Umfrage abgeleitet wurden. Schließlich wird das implementierte Dashboard für die Dokumentation von microservice-basierten Softwarearchitekturen vorgestellt.

AB - Die Dokumentation dynamischer Softwaresysteme, wie jene welche eine microservice-basierte Architektur verfolgen, ist komplex. Vor allem die Notwendigkeit der Berücksichtigung unterschiedlicher Stakeholder mit verschiedenen Sichten und der Umstand, dass die benötigten Informationen über verschiedenen Systeme verteilt sind, tragen dazu bei. Die sich laufend ändernde Architektur dieser Systeme machen eine manuelle Dokumentation des Systems zeitund somit auch kostenintensiv. Aus diesem Grund ist es notwendig, die Dokumentation dynamischer Systeme zu automatisieren. Diese Arbeit beschäftigt sich mit der Umsetzung eines Dashboards, welches die Dokumentation aktuell hält und in welchem es möglich ist, Informationen aus unterschiedlichen Systemen zu integrieren. Zu Beginn der Arbeit werden grundlegende Begriffe aus den Bereichen Softwarearchitektur und Architekturdokumentation diskutiert. Anschließend werden Anforderungen an das Dashboard definiert, welche aus vorhandener Literatur und einer Umfrage abgeleitet wurden. Schließlich wird das implementierte Dashboard für die Dokumentation von microservice-basierten Softwarearchitekturen vorgestellt.

M3 - Master-/Diplomarbeit

ER -