[Best-Practice-Dokumentation] Project Medieval Maritime Predation: Project Phase 30.01.2023 – 31.07.2023

DMMP project phase 01/30/2022 – 07/31/2023

Involved persons

Project: Database of Medieval Maritime Predation (Link zur Datenbank DMMP)

Project Group: Nikolas Jaspert (ZEGK), Victòria Burguera (ZEGK), Laurin Herberich (ZEGK), Silvia Girona Espino (ZEGK), Viola Herschbach (ZEGK), Nabi Bauermeister (ZEGK)

IT-Team: Nils Weiher (UB), Leonhard Maylein (UB)

Extended Project Group: Leonhard Maylein (UB), Nils Weiher (UB),Nikolas Jaspert (ZEGK), Victòria Burguera (ZEGK), Laurin Herberich (ZEGK), Kilian Schultes (ZEGK), Dominic Kempf (SSC),  Jonathan Gaede (FITCH), Florian Nieser (HCDH)

Timeline of the Project

February 2023

• Alpha Version of Zotero Literature Plugin courtesy of the SSC
• IT-team begins implementation of Excel data model into easydb

March 2023

• Autocomplete Fields identified and added
• Data entry process: From the document to literature, literature only to feature as a linkable object and not as a root for the linkage of other objects

April 2023

• Project group starts checking already implemented object types
• Two thirds of the data model are implemented into easydb

May 2023

• Domain is agreed upon: http://dmmp.ub.uni-heidelberg.de/
• Project group continues checking already implemented object types, while improving on and adding to the excel model
• Event OT: Spawning any event from any document, also from map, painting, and material object
• DMMP alpha is ready: IT-team finishes implementation of Excel model into easydb
• Project group and IT-team begin to streamline the DMMP alpha’s model, i.e. which fields can/should be used in multiple document/event types and which fields should be repeatable
• Silvia Girona Espino (ZEGK) joins the project group

June 2023

• “Helper Object” solution for “DT/EV” issue is implemented
• “Helper Object” solution for “Missing Person” issue is implemented
• Decision to enter vessels is made
• “Documents first” entry process is agreed upon

July 2023

• Milestone reached: DMMP Beta is ready for data entry after wipe of test data and restructuring of alpha version
• Project group hands over low and high priority lists of corrections to IT-team
• Project group begins mass data entry

Knowledge and data management

At the end of the project’s phase one in late February 2023, the project group in close coordination with the UB’s IT-team laid out an action plan for the time period until 31 July 2023. Phase two was to end with the implementation of the Excel model into easydb and thus an alpha version of the database. Phase three was to conclude with a working beta of the DMMP.

By late February 2023 the UB’s IT-team started to implement the Excel draft containing the organisational prototype of the DMMP into easydb. During the implementation process, the project group already prepared update 1.0 of the DMMP’s projected alpha version. Apart from added features like the Zotero literature plugin realised by the SSC, update 1.0 changed the model in two significant ways. The first change was to to reduce literature as a “non spawner” (NSP) and limit the data entry process to the document and event object types. Second, any event was to be spawnable from any document. Rather than to wait for the completion of the implementation process, the project group in conjunction with the IT-team decided to implement update 1.0 of the projected DMMP alpha simultaneously to avoid doubling work steps. During this prolonged phase, the project group started to scrutinise the already implemented object types. Phase two ended with the full implementation of not only the Excel model but also Update 1.0 into easydb on 24 May 2023.

Phase three kicked off with an addition of the project group. Silvia Girona Espino joined as project assistant and started to collect geodata on medieval harbours in an Excel sheet to be mass imported into the DMMP as place objects. Furthermore the modus operandi of project group and IT-team changed. Improving the DMMP’s model towards a working beta version ready for large scale data entry, required much closer coordination. Thus, almost twice a week throughout June and early July both groups met to weed out implementation errors and to streamline the model. The latter involved determining the which fields could be utilised in multiple document and event object types as well as identifying fields that should be repeatable in so called nested tables. The latter was of special importance because of the difficulty attached with turning non-repeatable fields into repeatable ones after data entry had already begun.

Phase three further marked a big step forward for the database as two major findability issues were found and solved. First was the “DT/EV” issue caused by the DT/EV object type, which was until then the fourth of the DMMP’s OT’s (event OT, document OT, NSP, document/event OT). The DT/EV OT was set up as one part document containing no information on NSPs mentioned in the document (Place, Natio, Dominion, Authority, Corporation, Type of Vessel, Goods, Currency and crucially Person) and one part event which contained all the NSP information to avoid entering it twice. But the lack of NSP information in the document part resulted in these documents not being linked to, e.g. persons, and thus not appearing when searching a person. To be able to track the documentary food print of a person, project group and IT-team agreed to discontinue the DT/EV object type, to separate the existing DT/EV OT’s into document OT’s and event OT’s, and to avoid doubling information nonetheless by employing a tool called “Helper Object”. This feature of the easydb serves as a container for two OT’s which it then links and displays together, thus solving the findability problem caused by the “DT/EV” issue. The “Helper Object” tool prooved to be the solution for the second findability issue as well. This “Missing Person” issue appeared when searching for a person which appeared in an event linked to a document but was not linked to said document. Not only did searching for a person result in an incomplete documentary record but finding the document the person was originally mentioned in became impossible once an event had been linked to several documents. Using the “Helper Object” the IT-team was able to link person and document in these cases as well, thus ensuring that every search for a person is going to display their full documentary record.

A third issue concerned scientific credibility. Until late June, data entry was possible beginning with a document OT as well as an event OT. Thus, the interpretation of historical documents in the form of an event created as a result of historical research could have stood without distinction next to said documents as a seemingly historical “fact”. Hence, to keep research results separate from historical documents, the decision was made to root the data entry process in the document object type alone. To keep track of the documental origin of historical information in the DMMP, every entry was to begin with the creation of a document from which the various other object types were to be spawned. When the implementation of the “documents first” entry process and the “Helper Object” solution were agreed upon on 23 June, the project group additionally opted to track individual vessels as a NSP OT as well. Once all changes had been implemented, test data was entered to ensure the functionality of the solutions. Despite the already high workload of the IT-team, the latter adapted smaller changes deemed necessary after the test data trials and delivered a working beta of the DMMP on 12 July 2023.

Since then, the IT-team has been working on the chronology plugin, which will simplify later visualisation of historical data recorded according to different calendars. The project group has meanwhile begun data entry into the DMMP.

Collaboration/communication within the project

At the beginning of the second project phase, new communication parameters were defined. The project group decided on a meeting of the project group members every second week to ensure an even workload. While phase one had been characterised by weekly meetings of project group and IT-team, phase two’s goal, the implementation of the DMMP’s excel model into easydb, called for less personal and more virtual communication via email and gitlab. This implementation phase leading to the DMMP’s alpha version was thus characterised by less personal meetings, only six from March to the end of May. Instead, the project group and the UB’s IT-team communicated mostly via email and gitlab, with email correspondence increasing especially in the final stages of the implementation process at the end of May.

When necessary, both groups were able to switch seamlessly back to in person meetings. The benefits of the latter format became apparent especially during phase three of the project. From June to July 2023 project group and IT-team aimed to turn the DMMP’s alpha version into a working beta. In the process, hot button issues regarding findability as well as scientific credibility had to be resolved and translated into sustainable and future proof solutions. It became apparent that to make decisions impacting the core of the DMMP’s model, frequent and immediate meetings were most effective. Another useful tool to improve a model which has been worked on continuously by a select group prooved to be the perspective of a less involved one. An “outsider’s perspective” can indeed be vital for a database’s functionality.

After the main issues had been resolved, programming specific communication between project group and IT-team revolved back to email and gitlab for the rest of July. As in phase one of the project, this ensured inclusive, mutual exchange and support, not least due to the ambition of the project group and the IT-team to avoid delay in answering requests.

 

— Deutsche Version —

 

DMMP Projektphase 30.01.2023 – 31.07.2023

Involvierte Personen

Projekt: Database of Medieval Maritime Predation (Link zur Datenbank DMMP)

Projektgruppe: Nikolas Jaspert (ZEGK), Victòria Burguera (ZEGK), Laurin Herberich (ZEGK), Silvia Girona Espino (ZEGK), Viola Herschbach (ZEGK), Nabi Bauermeister (ZEGK)

IT-Team: Nils Weiher (UB), Leonhard Maylein (UB)

Erweiterte Projektgruppe: Leonhard Maylein (UB), Nils Weiher (UB),Nikolas Jaspert (ZEGK), Victòria Burguera (ZEGK), Laurin Herberich (ZEGK), Kilian Schultes (ZEGK), Dominic Kempf (SSC),  Jonathan Gaede (FITCH), Florian Nieser (HCDH)

Bisheriger zeitlicher Verlauf des Projekts

Februar 2023

• Integration der Alpha Version des Zotero Literatur Plugins mit freundlicher Unterstützung durch das SSC
• Das IT-Team beginnt mit der Implementierung des Excel-Datenmodells in easydb

März 2023

• Autocomplete Felder identifiziert und hinzugefügt
• Dateneingabeprozess: Vom Dokument zur Literatur, Literatur nur als verknüpfbares Objekt und nicht als Wurzel für die Verknüpfung anderer Objekte

April 2023

• Die Projektgruppe beginnt, bereits implementierte Objekttypen zu prüfen
• Zwei Drittel des Datenmodells sind in easydb implementiert

Mai 2023

• Domain wurde festgelegt als: http://dmmp.ub.uni-heidelberg.de/
• Die Projektgruppe setzt die Überprüfung bereits implementierter Objekttypen fort und verbessert und ergänzt das Excel-Modell.
• Event OT: Erzeugen beliebiger Ereignisse aus beliebigen Dokumenten, auch aus Karten, Gemälden und materiellen Objekten
• DMMP alpha ist bereit: das IT-Team schließt die Implementierung des Excel-Modells in easydb ab
• Die Projektgruppe und das IT-Team beginnen, das DMMP-Alpha-Modell zu optimieren, d.h. welche Felder in mehreren Dokumenten/Ereignisarten verwendet werden können/sollen und welche Felder wiederholbar sein sollen
• Silvia Girona Espino (ZEGK) wird Teil der Projektgruppe

Juni 2023

• “Helper Object” Lösung wird für das “DT/EV”-Problem implementiert
• “Helper Object” Lösung wird für das “Missing Person”-Problem implementiert
• Entscheidung für die Eintragung von Schiffen wird getroffen
• “documents first” Eintragungsprozess wird festgelegt

Juli 2023

• Meilenstein erreicht: DMMP Beta ist nach der Löschung von Testdaten und der Umstrukturierung der Alpha-Version bereit für die Dateneingabe
• Die Projektgruppe übergibt dem IT-Team Listen mit Korrekturen von geringer und hoher Priorität
• Die Projektgruppe beginnt mit der Massendatenerfassung

Wissens- und Datenmanagement

Am Ende der ersten Projektphase im späten Februar 2023 legte die Projektgruppe in enger Abstimmung mit dem UB IT-Team einen Aktionsplan für den Zeitraum bis zum 31. Juli 2023 fest. Phase zwei sollte mit der Implementierung des Excel-Modells in easydb und damit einer Alpha-Version der Datenbank abgeschlossen werden. Phase drei sollte mit einer funktionierenden Beta-Version der DMMP enden.

Ende Februar 2023 begann das IT-Team der UB damit, den Excel-Entwurf, der den organisatorischen Prototyp des DMMP enthält, in easydb zu implementieren. Während des Implementierungsprozesses bereitete die Projektgruppe bereits Update 1.0 der geplanten Alpha-Version der DMMP vor. Abgesehen von zusätzlichen Funktionen wie einem Zotero Literatur-Plugin, das vom SSC realisiert wurde, änderte Update 1.0 das Modell in zwei Punkten. Die erste Änderung bestand darin, Literatur zu einem “Nicht-Spawner” (NSP) zu degradieren und den Dateneingabeprozess auf die Objekttypen Dokument und Ereignis zu beschränken. Zweitens sollte jedes Ereignis aus jedem Dokument erzeugt werden können. Anstatt den Abschluss des Implementierungsprozesses abzuwarten, beschloss die Projektgruppe in Zusammenarbeit mit dem IT-Team, Update 1.0 der DMMP alpha gleichzeitig zu implementieren, um doppelte Arbeitsschritte zu vermeiden. Da es Phase zwei insgesamt verlängerte, begann die Projektgruppe die bereits implementierten Objekttypen zu überprüfen. Phase zwei endete mit der vollständigen Implementierung sowohl des Excel-Modells in easydb als auch des ersten Updates am 24. Mai 2023.

Die dritte Phase begann mit einer Erweiterung der Projektgruppe. Silvia Girona Espino kam als Projektassistentin hinzu und begann damit, Geodaten über mittelalterliche Häfen in einer Excel-Tabelle zu sammeln, um sie als Ortsobjekte in die DMMP zu importieren. Außerdem änderte sich der Modus Operandi der Projektgruppe und des IT-Teams. Die Verbesserung des DMMP-Modells hin zu einer funktionierenden Beta-Version, die eine umfangreiche Dateneingabe ermöglicht, erforderte eine viel engere Koordinierung. So trafen sich beide Gruppen im Juni und Anfang Juli fast zweimal wöchentlich, um Implementierungsfehler auszumerzen und das Modell zu optimieren. Letzteres beinhaltete die Bestimmung von Feldern, die in mehreren Dokument- und Ereignisobjekttypen verwendet werden können, sowie die Identifizierung von Feldern, die in so genannten “Nested Tables” wiederholbar sein sollten. Letzteres war von besonderer Bedeutung, da es schwierig gewesen wäre, nach Beginn der Dateneingabe nicht wiederholbare Felder in wiederholbare umzuwandeln.

Abbildung 1

Abbildung 2

Phase drei bedeutete einen weiteren großen Schritt nach vorn für die Datenbank, da zwei wichtige Auffindbarkeitsprobleme gefunden und gelöst wurden. Das erste war das “DT/EV”-Problem, das durch den DT/EV-Objekttyp verursacht wurde, der bis dahin der vierte der OTs der DMMP war (Ereignis-OT, Dokument-OT, NSP, Dokument/Ereignis-OT). Der DT/EV OT bestand aus einem Dokumententeil, der keine Informationen über die im Dokument erwähnten NSP enthielt (Ort, Nation, Herrschaft, Behörde, Körperschaft, Schiffstyp, Waren, Währung und vor allem Person), und einem Ereignisteil, der alle NSP-Informationen enthielt, um doppelte Eingabe zu vermeiden. Das Fehlen von NSP-Informationen im Dokumententeil führte jedoch dazu, dass diese Dokumente z.B. nicht mit Personen verknüpft wurden und daher bei der Suche nach einer Person nicht auftauchten. Um den dokumentarischen Lebenslauf einer Person verfolgen zu können, einigten sich die Projektgruppe und das IT-Team darauf, den DT/EV-Objekttyp abzuschaffen, die bestehenden DT/EV-OTs in Dokument-OTs und Ereignis-OTs aufzuteilen und dennoch die doppelte Eingabe von Informationen zu vermeiden, indem ein Werkzeug namens “Helper Object” eingesetzt wird. Diese Funktion der easydb dient als Container für zwei OT’s, die dann miteinander verknüpft und angezeigt werden, wodurch das durch das “DT/EV”-Problem verursachte Auffindbarkeitsproblem gelöst wird. Das “Helper Object”-Tool erwies sich auch als Lösung für das zweite Auffindbarkeitsproblem. Dieses “Missing Person”-Problem trat bei der Suche nach einer Person auf, die in einem mit einem Dokument verknüpften Ereignis auftauchte, aber nicht mit dem genannten Dokument verknüpft war. Die Suche nach einer Person führte nicht nur zu einem unvollständigen Datensatz, sondern es war auch unmöglich, das Dokument zu finden, in dem die Person ursprünglich erwähnt wurde, sobald ein Ereignis mit mehreren Dokumenten verknüpft war. Mit Hilfe des “Helper Object” konnte das IT-Team auch in diesem Fällen eine Verknüpfung zwischen Person und Dokument herstellen und so dafür sorgen, dass bei jeder Suche nach einer Person deren vollständiger dokumentarischer Datensatz angezeigt wird.

Ein dritter Punkt betraf wissenschaftliche Glaubwürdigkeit. Bis Ende Juni war die Dateneingabe sowohl über einen Dokumenten-OT als auch einen Ereignis-OT möglich. So hätte die Interpretation historischer Dokumente in Form eines aus historischer Recherche rekonstruierten Ereignisses als scheinbar historische “Tatsache” unterschiedslos neben den Dokumenten stehen können. Um die Forschungsergebnisse von den historischen Dokumenten zu trennen, entschied man sich daher, die Datenerfassung allein im Objekttyp Dokument zu verankern. Um den dokumentarischen Ursprung historischer Informationen in der DMMP zu verfolgen, sollte jeder Eintrag mit der Erstellung eines Dokuments beginnen, aus dem die verschiedenen anderen Objekttypen hervorgehen sollten. Als man sich am 23. Juni auf die Einführung des “documents first”-Eingabeprozesses und die “Helper Object”-Lösung einigte, entschied sich die Projektgruppe zusätzlich dafür, einzelne Schiffe auch als NSP OT zu erfassen. Nachdem alle Änderungen umgesetzt waren, wurden Testdaten eingegeben, um die Funktionalität der Lösungen sicherzustellen. Trotz der bereits hohen Arbeitsbelastung des IT-Teams passte dieses kleinere Änderungen an, die nach den Testdaten für notwendig erachtet wurden, und lieferte am 12. Juli 2023 eine funktionierende Beta-Version der DMMP.

Seitdem arbeitet das IT-Team am Chronologie-Plugin, das die spätere Visualisierung der nach verschiedenen Kalendern erfassten historischen Daten vereinfachen wird. Die Projektgruppe betreibt seit Juli 2023 intensiv die Dateneingabe.

Abbildung 3

Abbildung 4

Zusammenarbeit/Kommunikation innerhalb des Projektes

Zu Beginn der zweiten Projektphase wurden neue Kommunikationsparameter festgelegt. Die Projektgruppe beschloss ein Treffen der Projektgruppenmitglieder alle zwei Wochen, um eine gleichmäßige Arbeitslast zu gewährleisten. Während die erste Phase durch wöchentliche Treffen der Projektgruppe und des IT-Teams gekennzeichnet war, erforderte das Ziel der zweiten Phase, die Implementierung des DMMP Excel Modells in easydb, weniger persönliche und mehr virtuelle Kommunikation via Email und Gitlab. Diese Implementierungsphase, die zur Alpha-Version der DMMP führte, war daher durch weniger persönliche Treffen gekennzeichnet, nur sechs von März bis Ende Mai. Stattdessen kommunizierten die Projektgruppe und das IT-Team der UB hauptsächlich über E-Mail und Gitlab, wobei die E-Mail-Korrespondenz vor allem in den letzten Zügen des Implementierungsprozesses Ende Mai zunahm.

Bei Bedarf konnten beide Gruppen nahtlos zu persönlichen Treffen zurückkehren. Die Vorteile des letztgenannten Formats wurden vor allem in der dritten Phase des Projekts deutlich. Von Juni bis Juli 2023 arbeiteten Projektgruppe und IT-Team daran, die Alpha-Version der DMMP in eine funktionierende Beta-Version zu überführen. In diesem Prozess mussten wichtige Fragen der Auffindbarkeit und der wissenschaftlichen Glaubwürdigkeit geklärt und in nachhaltige und zukunftssichere Lösungen umgesetzt werden. Es wurde deutlich, dass häufige und auch kurzfristige Treffen am effektivsten waren, um Entscheidungen zu treffen, die den Kern des DMMP-Modells betrafen. Als weiteres nützliches Instrument zur Verbesserung eines Modells, an dem eine ausgewählte Gruppe kontinuierlich gearbeitet hat, erwies sich die Perspektive einer weniger involvierten Gruppe. Die “Außenseiterperspektive” kann in der Tat entscheidend für die Funktionalität einer Datenbank sein.

Nachdem die wichtigsten Fragen geklärt waren, wurde die programmierspezifische Kommunikation zwischen der Projektgruppe und dem IT-Team für den Rest des Monats Juli wieder auf E-Mail und Gitlab umgestellt. Wie in der ersten Phase des Projekts wurde so ein umfassender, gegenseitiger Austausch und gegenseitige Unterstützung gewährleistet, nicht zuletzt aufgrund des Bestrebens der Projektgruppe und des IT-Teams, Verzögerungen bei der Beantwortung von Anfragen zu vermeiden.

 

 

---

---