Kurzbericht | 11. Mai 2023

Weiterentwicklung von Kompakkt innerhalb von NFDI4Culture

Kompakt ist eine webbasierte Softwarelösung, die es ermöglicht 3D Objekte kollaborativ und multimedial im Browser bereitzustellen, annotieren, teilen und zu entdecken. Kompakkt hat das Ziel, diese Komponente weiter auszubauen und zugänglicher für die Community zu gestalten. Innerhalb des vergangenen NFDI4Culture-Förderzeitraums hat das Team folgende Arbeitspakete priorisiert:

• Refaktorisierung der Codebasis
• Erweiterung der E2E Tests
• Ergänzung von Messwerkzeugen
• Verbesserter Support von mobilen Endgeräten
• Ausbauen des User-Supports

Im folgenden Dokument wird die Arbeit, die für die Ausführung dieser Arbeitspakete getätigt wurde, geschildert und deren Ergebnisse evaluiert.

Refaktorisierung

Kompakkt hat das langfristige Ziel, eine Open Source Community auszubauen, die intrinsisch motiviert ist, das Produkt auf eine zukunftsorientierte Weise zu entwickeln. Um mit der technischen Evaluation sowie den Bedürfnissen der Community mitzuhalten, hat das Arbeitspaket Refaktorisierung der Codebasis als Grundlage für die Weiterentwicklung agiert. Die Refaktorisierung hat eine umfassende Überarbeitung des bestehenden Codes beinhaltet, um ihn robuster, effizienter, leicht verständlich und wartbar zu gestalten. Durch diese Refaktorisierung wurde die Grundlage für eine erfolgreiche Weiterentwicklung des Produkts geschaffen, die den Anforderungen der Community und den aktuellen technischen Standards entspricht. Es ist jedoch zu beachten, dass Refaktorisierung nie wirklich abgeschlossen ist und ständig weiter verbessert werden kann. Die Arbeit der letzten Monate hat jedoch eine gute Grundlage für Neueinsteiger gebildet, um einfacher in das Projekt einzusteigen und aktiv beizutragen, was auch in der neuen Zusammenarbeit mit der Technischen Informationsbibliothek Leibniz erkennbar ist.

Tests

Automatisierte End to End Tests (E2E) haben das Ziel, die Funktionen von einer Anwendung auf deren Verhalten zu testen und somit potenzielle Bugs im System systematisch zu finden und zu dokumentieren. Mit der Einführung eines E2E-Test-Grundgerüsts haben wir für die Kompakkt Community ermöglicht, dass neue Features zukünftig sicherer hinzugefügt und getestet werden können. Die entwickelten E2E Tests können als Grundlage für die Weiterentwicklung der Anwendung genutzt werden und bieten somit eine langfristige Lösung für das effiziente Testen der Webanwendung. Neben den E2E-Tests haben wir zudem Integrationstests für den Kompakkt Server erstellt, um komplexere Server Abläufe zu simulieren und nachzuempfinden, wodurch eine detaillierte Fehleranalyse und Fehlerbehebung ermöglicht wurde. Damit kann der Kompakkt Server auch zukünftig um weitere Schnittstellen zu anderen Datenmodellen und Funktionen erweitert werden, ohne bestehende Funktionalität einzuschränken.

User Support

Um den Community-Impact von Kompakkt zu steigern, hat das Entwicklungsteam die Evaluation des Nutzerverhaltens als Priorität festgelegt. Dies ist ein wichtiger Schritt für das gesamte Entwicklungspaket gewesen, einschließlich Refaktorierung und E2E Tests. Um die Anwendbarkeit von Kompakkt zu testen, wurden User Tests durchgeführt, die sowohl auf mobilen Geräten als auch auf Computern durchgeführt wurden. Vor den Sessions wurden den Nutzern die wichtigsten Funktionen von Kompakkt demonstriert und sie wurden in kleine Gruppen aufgeteilt, um die Kernfunktionalitäten von Kompakkt aktiv auszuprobieren, mit besonderem Fokus auf Kollaboration und Annotation. Die Ergebnisse dieser Tests wurden verwendet, um die Entwicklung von Epics und User Stories zu unterstützen. Dabei wurden die wichtigsten Komponenten von Kompakkt als Service identifiziert. Die Kernbestandteile der Anwendung wurden durch die Durchführung von User Stories in besseren Details erfasst und sind für die Etablierung eines ansprechenden und benutzerfreundlichen Produkts von grundlegender Bedeutung.
Kompakkt hat das Ziel, einen Open Source Ansatz weiter zu etablieren. Dies ist innerhalb der letzten Förderung mittels verbesserter und verkürzter  Kommunikationskanäle zwischen dem Kernteam und dem Nutzen entwickelt.

Support von mobilen Endgeräten

Um den Support von mobilen Endgeräten weiter auszubauen, hat das Team zuerst eine Evaluation des bisherigen Status durchgeführt. Dies ist durch das explorative Testen auf unterschiedlichen Endgeräten auf Hauptfunktionen vom Viewer geschehen. Die Benutzerfreundlichkeit des Betrachtens des Viewers hat eine höhere Priorität als das Annotieren auf mobilen Endgeräten und dementsprechend wird für Annotationen ein Computer oder Laptop empfohlen.

Ergänzung von Messwerkzeugen

Im Sinne der erweiterten und erleichterten Bedienung im Viewer, wurde mithilfe von Nutzerstudien und Anfragen festgestellt, dass die Messwerkzeuge im Viewer nicht für alle Anwendungsfälle erforderlich sind, aber für die, bei denen sie erforderlich sind, Präzision notwendig ist. Es gibt keinen Weg, die Modellgröße akkurat über die Metadaten zu übertragen, weshalb eine Implementation von Messwerkzeugen eine genauere technische Erarbeitung erfordert. Der Nutzer legt über den Viewer Punkte am Modell fest, die mit echten Längenmaßen verknüpft sind. Dadurch wird das Modell im dreidimensionalen Raum dargestellt, um die Maßeinheiten nachvollziehbarer zu gestalten.
In diesem Prozess wurde erarbeitet, wie man Annotationen, die mehrere Punkte an einem Modell gleichzeitig betreffen, wie z.B. eine Messung im Datenmodell der Annotationen behandelt werden sollte, da vorher nur 1-Punkt-Annotationen im Viewer verfügbar gewesen sind. Messungen werden dabei als Sonderfälle von Multi-Punkt-Annotationen behandelt.
Mehr-Punkt-Annotationen legen nicht nur den Grundstein für Messungen im Kompakkt Viewer, sondern bieten zukünftig auch die Möglichkeit für Funktionalitäten wie Flächenannotationen.