Diese Dokumentation (Entwurf)

Feedback und Beteiligung

Die AG FOLIO hat das Schreibrecht, weitere Autor:innen sind aber herzlich willkommen. Sie müssen aber nicht gleich mitschreiben, sondern können jederzeit Rückmeldungen zu Fehlern oder Wunschthemen geben. Auch können Sie sehr (!) gerne eigene Workflows oder anderweitige Tipps zur Verfügung stellen, die in die Dokumentation übernommen werden sollen. In allen Fällen, schreiben Sie dazu bitte an

• gbvagfolio@lists.gbv.de

Zugang

(1) Autologin via https://verweisungsform.de/GBV-Folio-Dokumentation-Autologin (siehe index.html)

Quellen

Bedeutsame Quellen sind

• Offizielle FOLIO-Dokumentation
• Folio-Wiki: Information and User Guides for FOLIO Apps
• Beiträge der Anwenderbibliotheken
• FOLIO- Project: DACH-Fachgruppen (insbesondere Ausleihe, Erwerbung, Metadaten Management und Übersetzung)

Lizenz und Version

Diese Dokumentation basiert auf der FOLIO-Version Morning Glory. Zitieren und nachnutzen:

“Projekt FOLIO GBV: Dokumentation” von AG FOLIO (GBV) veröffentlicht unter: https://info.gbv.de/display/FOLIOGBVEXTERN/GBV+FOLIO+Dokumentationn mit der Lizenz: CC-BY 4.0

Struktur

Die Struktur der Dokumentation orientiert sich an der Struktur der offiziellen Doku (siehe auch FOLIO Wiki: About Documentation> Content standards). Sie hat also Einleitung, Anhang und Hauptblöcke zu den großen Themen-/Aufgabenbereichen in Bibliotheken, wie Bestandszugang (Leihverkehr), Bestandmanagement (Erwerbung), Metadatenmanagement (Katalogisierung) und Electronic Resource Management (ERM). Die einzelnen FOLIO-Apps sind darunter zusammengefasst und beschrieben.

An vielen Stelle des Handbuchs, insbesondere unter den App-Seiten, gibt es eine Unterseite “Best Practises” und/oder “Workflows”. Diese Seiten haben jeweils Unterseiten, nach dem Schema “Einstellende Einrichtung: App/Thema + Aktion” (Beispiel: “TUB HH: Lizenzverträge Ersterfassung”). Für Workflows aus dem Original-Foliohandbuch ist “Folio: " vorangestellt.

Zusätzlich werden den Seiten Confluence-Labels vergeben, womit sich dann Übersichten und Filterungen generieren lassen, die auch unabhängig von der (primären) hierarchischen Dokumentationsstruktur. Siehe dazu insbesondere die Übersichtslisten aus Tags im Index. Dort ist jeweils auch die Verwendung eines einzelnen Tags nochmal näher erläutert.

Beispiel folgen hier drunter, solange es nur Vorschlagscharakter hat und es noch keine Extraseite gibt. Die Labels könnten ggf. noch spezifischer gewählt werden, lassen sich aber später auch noch (relativ) leicht anpassen. Es gibt folgende Labelkategorien, die bei den meisten Beitrag (fast) alle vergeben werden sollten

• by-
  • Vom wem stammt der Beitrag. Zum Beispiel by-ag_folio, by-folio, by-tubhh, by-vzg, by-zbw
  • Besonders: by-community_x für gemeinschaftlich gepflegte/ergänzte Dokumente. Um diese einfach für Übersichten filtern zu können, aufgeteilt in zwei Tags:
    • by-community_einzelbeitrag: immer zusammen mit by-NAME_DER_EINRICHTUNG wie die Beispiele im ersten Spiegelstrich
    • by-community_gemeinsam: Dokumente, die wirklich von vielen Einrichtungen direkt ergänzt werden (ein gutes Beispiel sind die Lizenbedingungen für Lizenverträge).
• for-
  • Für welche Zielgruppe ist der Beitrag? Derzeit for-anwender für z.B. Workflows in den Apps selbst und for-admin für Workflows bei den App-Einstellungen.
  • In Testphase: for-entwickler (sinngemäß auch für SIGs).
• cat-
  • Typ des Beitrag. Zum Beispiel cat-bestpractises (von Anwendern), cat-workflows (von Folio und von Anwendern), cat-einstellungen (von Folio), sowie cat-berechtigungen (meist zugleich Beschreibung der app selbst)
  • cat- meint eher starre, wiederkehrende Strukturelement der Dokumentation. Topic- (siehe unten) hingegen können mehr und freier gewählt werden
• app-
  • Name der beteiligten Folio-App(s). Zum Beispiel app-personen, app-organisationen
  • Sonderfall “app-einstellungen”. Da Einstellungen zu spezifischen Apps werden mit app-NAME und cat-einstellung gettagt. Globale Einstellungen werden mit app-einstellungen getaggt. Das ist nicht unbedingt logisch oder am sinnvollsten, aber Konvention für den Moment. Um weiterhin Filterungen zu erlauben, gibt es zusätzlich auch cat-eisntellungen.
  • In Testphase (Sonderfall): app-gokb und app-laser, weil es sich gut ins Schema (by-x und for-x und app-x und cat-x) einfügt. Wird aber eventuell noch geändert.
• topic-
  • Manche Dinge sollen übergreifend auffindbar sein. Beispiele topic-passwort, topic-tags, topic-datenschutz, topic-edi, topic-exemplarstatus, topic-sip2, topic-kbart und eben viele mehr potentiell.
• meta-
  • Tags, die die Bearbeitung dieser Dokumentation unterstützen. Zum Beispiel meta-Dokumentation (Alles Festlegungen etc. rund um die Dokumentation) und meta-Entwurf (unfertige aber ggf. veröffentlichte Seiten)
  • dev-bug (wurde übersprünglich benutzt, soll aber durch ein meta-fehler o.ä. abgelöst werden ggf.)
    • Gelegentlich fallen beim Schreiben/Übersetzen Fehler auf, die aber nicht sofort gemeldet werden können oder ggf. nochmal geprüft werden müssen. Um die wiederzufinden, ist dieser spezielle Tag vergeben.

Hintergrund

Diese Dokumentation dient sowohl als deutsches Handbuch, als auch als Quelle für Ablaufbeschreibung/Workflows und Best Practises. Die folgenden Rahmenbedingungen wurden bis Dezember 2022 von der GBV-AG FOLIO festgelegt

• Sprache ist Deutsch
• Zielgruppen sind primär Anwender:innen und Systembetreuer :innen der Anwenderbibliotheken im GBV.
• Lizenz der Dokumentation ist CC By
• Die Dokumentation ist offen im Netz verfügbar. Sie wird mit Confluence bereitgestellt und daher sind aus technischen Gründen Zugangsdaten nötigt. Siehe Abschnitt weiter oben.

Die Dokumentation startet Ende Dezember 2022 und übernimmt die Struktur der offiziellen englischsprachigen FOLIO-Dokumentation unter https://docs.folio.org/zu als Grundlage. Hintergrundinformationen dazu gibt es unter Folio-Wiki: Support SIG Home > FOLIO Documentation. Dort erfährt man u.a., dass die  FOLIO-Dokumentation Hugo verwendet, einem Tool um statische Webseiten zu erzeugen. Sprachversionen können leicht ergänzt/übernommen werden und tatsächlich gab es bereits früher einen Anlauf eine deutsche Version bereitzustellen. Zusätzlich wird diese Dokumentation für jedes FOLIO-Release erstellt.