This is an old revision of the document!
Als Ausgangsbasis für die Entwicklung dient der Code des Metadateneditor V2.
Projektstatus
Projektstart war am 2. September 2024. Aktuell befindet sich das Projekt im fünften Sprint. Hauptziel dieses Sprints ist es, bereits erstellte XML-Dateien im Editor hochladen zu können. Der Sprint endet am 19. Dezember 2024 mit einer Sprint Review um 10:00 Uhr. Alle Stakeholder sind herzlich dazu eingeladen daran teilzunehmen.
Zukünftige Termine
Weitere Sprint Reviews wird es zu folgenden Terminen geben:
- 2. Januar 2025 um 10:00 Uhr
- 13. März 2025 um 10:00 Uhr
Feature Requests
Die aktuelle Testversion kann auf unserem Testserver abgerufen werden. Diese Version wird nach jedem Sprint aktualisiert. Solltest du einen Fehler gefunden haben, oder einen Verbesserungsvorschlag haben, bieten wir im Metadateneditor ein kleines Feedback-Formular an, das über den gelben Button oben rechts aufgerufen werden kann. Wir sind dankbar über jedes Feedback,, das uns darüber erreicht.
Dokumentationen
Wir entwickeln mit einem Continuous Documentation Ansatz, d. h. das die Dokumentationen bereits während der Entwicklung geschrieben werden.
Technische Dokumentation ("ReadMe")
Die technische Dokumentation befindet sich aktuell in unserer ReadMe auf GitHub.
Endanwender Dokumentation ("Guide")
Die Dokumentation für Endanwender bzw. Forschende nennen wir Guide und dieser ist bereits in der Testversion der Anwendung integriert.
API Dokumentation
Für zukünftige Neuentwicklungen des Gesamtsystems bieten wir eine Schnittstelle an um z. B. die kontrollierten Vokabularien auch anderweitig nutzen zu können. Auch Updates der externen Vokabularien sind damit (z. B. über einen regelmäßig auszuführenden CronJob) möglich. Die Dokumentation zur API wird im OpenAPI-Standard 3.1 angeboten und ebenfalls während der Entwicklung aktualisiert.
Code Dokumentation
Für die Dokumentation unserer PHP-Funktionen nutzen wir das PHPDoc-Format im Quellcode. Anlog nutzen wir zur Dokumentation von JavaScript-Code den Standard JSDoc. Um unseren Code lesbar zu halten, pflegen wir einen Code Styleguide.
