2026‐09‐07 Community Board (Kitodo.Production) - kitodo/kitodo-production GitHub Wiki

Teilnehmende: André Hohmann, Anja Piller, Armin Möller, Christoph Bartmann (M), Katharina Gart , Kerstin Wendt (P), Lole Westedt (E), Matthias Kissler - Gast: Daniel Opitz

Doku-Vorschlag Daniel Opitz

  • GitHub kein guter Ort für die Präsentation der Anwenderdokumentation vor allem wegen der engen Grenzen für Strukturierung der Themen und wegen der fehlenden gezielten Durchsuchbarkeit
  • Vorschlag: Weiterarbeit an den Einzelseiten in GitHub in Verbindung mit Nutzung des Tools Zensical als static site generator. Die Grundlage für die Struktur der Website ist dazu in einer Markdown-Datei zu konfigurieren und anzupassen (s. https://github.com/danielopitz/kitodocs/blob/main/_nav.md). Die Verlinkung innerhalb der Dokumentation bleibt konsistent und das Tool ist in der Lage nicht funktionierende Links aufzudecken. Das Bauen der Site ist im Umfeld von GitHub möglich nach Aufsetzen eines neuen Repos "Documentation". Das CB möchte diesen Weg gehen und Ergebnis beim Anwendertreffen vorstellen und Brauchbarkeit abfragen.
  • Beim Praxistreffen wurde stark das Fehlen eines WYSIWYG Editors moniert. Eine einfache technische Lösung gibt es nicht, wenn man eine Verortung im GitHub beibehalten will. Einschätzung im CB: Oftmals spielen die lokalen Anwenderdokumentationen mit konkreten Vorgaben eine größere Rolle als diese Anwenderdokumentation. Eine Verbesserung des Qualitätslevels ist wahrscheinlich am ehesten über eine bessere Organisation zu erreichen: Konkrete Verantwortlichkeiten für Teilbereiche, Abgabe von Textdateien beim CB anbieten, Beteiligung an Diskussionen und Schreiben von Issues vermitteln. Infoseite dazu schreiben und über ein Community Treffen dazu ins Gespräch kommen.
  • Einschätzung von Daniel zu offenen Punkten in der systembibl. Dokumentation: Probleme ergeben sich am ehesten bei sehr spezifischen Details. Er vermisst am meisten gute Beispielen für Regelsatz und xslt zum Export. Die vorhandenen Beispiele sind entweder zu einfach oder zu komplex. Relevantes Thema für CB / Vorstand: Wie erreichen wir eine "Plug and Play-Umgebung" mit Beispielregelsatz/Export.xsl für DDB-Akzeptanz?

Zukunft der "Entwickler"-Dokumentation

  • Nebenthema: Installationsdokumentation war nicht ausreichend brauchbar - von SBB wesentlich erweitert im Zuge der eigenen Installation von Kitodo 4
  • Diskussion zu https://github.com/kitodo/kitodo-production/pull/7175
  • alte Entwicklerdoku zu löschen in jedem Falle richtige Entscheidung!!
  • Diskurs: nach Ansicht von Christoph Bartman sind Dokumentationsthemen wie Java-Version als Teil des Codes zu organisieren über PRs - weiterer Bedarf nicht zwingend für ihn erkennbar. Universelle Entscheidungen dann doch eher in den Bereich des Wikis "Hinweise für Entwickler" ?
  • Aufnahme des Austausches mit Stefan Weil spätestens beim Praxistreffen

mögliche Themen fürs nächste Treffen

Nächstes Treffen 05.10. 13.30 - 15.00

  • Moderation: Kerstin
  • Protokoll: Matthias Kissler