Appendix B — Hinweise zur Mitarbeit

Dieses Handbuch wird in einem offenen Prozess erarbeitet und verbessert. Mitarbeit ist dabei grundsätzlich sehr willkommen und in verschiedener Form möglich. Voraussetzung ist ein Verständnis des Arbeitsablauf, Einhaltung des Styleguide und die freie Lizensierung der eigenen Beiträge. Das Verfahren zur Aktualisierung des Handbuchs ist unter Technik beschrieben.

Arbeitsablauf

Der aktuelle Workflow beinhaltet folgende Schritte:

Schreiben
Neue Themen werden durch Gruppen im Rahmen von Book Sprints erstellt. Als Werkzeug zum freien Schreiben dient dabei beispielsweise Google Docs.
Lektorat
Fertige Kapitel werden einmalig nach Markdown konvertiert und im git-Repository des Handbuch abgelegt. Anschließend werden daraus DOCX-Dateien erstellt (Word) und in einem Google Drive Verzeichnis zum Korrekturlesen und Kommentieren bereitgestellt. Änderungen können auch mittels GitHub-Issues oder per Hinweis an die Autor*innen erfolgen.
Redaktion
Änderungen an bestehenden Kapiteln und an der Gesamtstruktur des Buches können direkt im git-Repository vorgenommen werden. Alternativ muss jemand Änderungsvorschläge aus den Kapitel-Kopien bei Google Drive einarbeiten und die DOCX-Datei aktualisieren.
Publikation
Änderungen an der Markdown-Dateien im git-Repository führen dazu, dass das Buch mittels quarto in HTML und anderen Formaten aus den Quellen zusammengebaut wird.

Styleguide

Dieser Styleguide soll eine einheitliche Form trotz unterschiedlicher Autor*innen gewährleisten. Dazu gibt es Hinweise zu Zielgruppe, Stil und Aktualität, Schreibweise und Struktur sowie Vorgaben zu besonderen Inhalten wie Bildern und anderen Medien, Literaturverzeichnis und Glossar.

Zielgruppe

Zur Klärung der Zielgruppe dieses Handbuchs wurden einige sogenannte Personas definiert:

  • Janine Buchinger: Janine leitet die Stadtbibliothek in einer Stadt mit 250.000 Einwohnern. Die Bibliothek besteht aus einer Zentrale und zwei Zweigstellen. Mit den Schulbüchereien besteht eine Kooperation für fachliche Beratung und gemeinsame Aktivitäten bei der Informationskompetenz-Vermittlung.

  • Dr. Tillmann Schuppe: Tillmann ist Leiter einer Fachhochschulbibliothek mit 500.000 Medieneinheiten. Die Bibliothek gehört einem Bibliotheksverbund an. Die Bibliothek plant einen Neubau, der gemeinsam mit dem Rechen- und Medienzentrum bezogen werden soll.

  • Magda Olsowski: Magda ist studierte Informatikerin und leitet die Gruppe Forschungsdatenmanagement an einer großen Universitätsbibliothek. Sie hat keine bibliothekarische Vorbildung.

  • Alicia Meyer: Alicia studiert Bibliotheksmanagement und plant eine Masterarbeit, in der sie die Implementierungsprozesse von Software analysieren möchte.

  • Robert Pohlmann: Robert leitet die IT-Abteilung einer mittelgroßen Universitätsbibliothek und ist nebenberuflich Lehrbeauftragter für einen bibliothekarischen Studiengang.

Stil und Aktualität

  • Journalistische oder enzyklopädische Neutralität sind nicht oberstes Prinzip dieses Buches. Es soll vielmehr fundiert und praxisorientiert informieren und beraten und darf dabei auch parteiisch sein.

  • Dieses Buch ist keine wissenschaftliche Forschungsveröffentlichung. Nicht jede Aussage muss mit einer Quelle belegt werden. Für die Anwendung in der Hochschullehre reicht es, wenn das Buch zentrale Aussagen belegt bzw. auf die wichtigsten aktuellen Studien verweist und somit auch Tipps zur weiterführenden Lektüre bietet.

  • Das Buch sollte in 2-5 Jahren noch aktuell und verständlich sein, aber nicht mehr unbedingt in 10 Jahren.

  • Das Buch soll als Nachschlagewerk dienen, das nicht vollständig durchgelesen werden muss. Dabei helfen Redundanz und Querverweise (siehe Hinweise zur Struktur).

Struktur

Struktur des Texts

  • Wir verwenden kurze, unverschachtelte Sätze.

  • Wir erzeugen Sinnabschnitte, die möglichst für sich stehend verständlich sind.

  • Wir schreiben stark strukturiert, also

    • mit vielen Zwischenüberschriften, bis maximal zur vierten Gliederungsebene,

    • wo es inhaltlich passt, in stichpunktartigen Listen und

    • mit Hervorhebung wichtiger Begriff durch Fettdruck als Gliederungshilfe.

  • Wir verwenden Infoboxen, die auch unabhängig vom übrigen Text lesbar sind.

  • Wir liefern wichtige Informationen zusätzlich zum Text in Form von Bildern, Tabellen, Listen, Infoboxen und/oder Zusammenfassungen.

Struktur der Hauptkapitel

Das Handbuch behandelt aufgeteilt in Hauptkapitel die wesentlichen Themen rund um IT in Bibliotheken.

  • Kapitel haben normalerweise einen Umfang von 3.000 bis 4.000 Wörtern. Deutlich längere Kapitel sind darauf zu prüfen, ob sie sich in mehrere Kapitel trennen lassen, und wenn das nicht möglich ist, müssen sie sorgfältig in Unterkapitel aufgeteilt werden.

  • Jedes Kapitel beginnt mit einer Kurzfassung als Infobox gefolgt von einer Einleitung und endet mit einem Abschnitt Zusammenfassung und Ausblick.

  • Jedes Kapitel beinhaltet ein aussagekräftiges Metadatenfeld description für Suchmaschinen (maximal etwa 158 Zeichen)

Schreibweise, Fachbegriffe und Verweise

  • Wir verwenden im gesamten Buch gendergerechte Schreibweise mit Sternchen (*). In Markdown ist es sicherer dem Sternchen einen Backslash voranzustellen, z.B. Autor\*innen.

  • Eine Schreibweise für häufig verwendete Fachbegriffe sollte quer durch das Buch eingehalten werden, so z.B. BMS für Bibliotheksmanagementsysteme

  • Fachbegriffe (z.B. Bibliotheksverbund) werden dort verwendet, wo sie wiederholt relevant sind, und werden bei ihrer ersten Erwähnung definiert. Die eingeführten Fachbegriffe müssen in einem Glossar für das gesamte Buch gebündelt werden.

  • Wir vermeiden IT-Jargon.

  • Quellen sollten nur dann genannt werden wenn in der jeweiligen Textpassage auch wirklich paraphrasiert oder wörtlich zitiert wird.

Typografie

  • Abkürzungen werden durch geschützte Leerzeichen getrennt (z. B.)

  • Gerade Anführungszeichen "..." werden automatisch durch die Deutschland und Österreich übliche Anführungszeichen („…“) ersetzt.

Externe Links, die nur auf Anbieter oder andere Websites verweisen, werden inline verlinkt.

  • Links, die auf später entstehende Kapitel verweisen, werden durch eckige Klammern kenntlich gemacht.

  • Kursive Hervorhebung sollte nur für Namen und Glossareinträge verwendet werden.

  • Wir verzichten auf Fußnoten.

Bilder und andere Medien

  • Bilder und andere Mediendateien kommen in das Verzeichnis media im git-Repository. Alternativ können sie von externen Quellen per URL eingebunden werden wenn die Quelle voraussichtlich dauerhaft verfügbar ist.

  • Bilder sollten möglichst als Vektorgrafik (SVG) bereitgestellt werden.

  • Bitte nutzt sprechende Dateinamen!

Literaturverzeichnis

Die zitierte und weiterführende Literatur wird in einer Zotero-Gruppe unter https://www.zotero.org/groups/4673379/it_in_bibliotheken verwaltet. Der BibLaTex-Export dieser Bibliographie wird mit Aufruf von make refs von dort heruntergeladen und unter references.bib gespeichert. Diese Datei sollte also nicht direkt bearbeitet werden! Innerhalb des Markdown-Quelltext kann mittels Pandoc-Citation Syntax und dem jeweiligen Citekey aus references.bib auf Literatur verwiesen werden.

Glossar

Das Glossar in der Datei glossar.yml enthält erklärungswürdige Begriffe mit Kurzbeschreibung und optionalem Link auf eine weiterführende Quelle (meist Wikipedia). Es werden _keine_ Firmennamen in das Glossar aufgenommen, auch wenn sie Akronyme sind. Die Glossarbegriffe werden in den Textdateien zur Hervorhebung kursiv gesetzt (in Markdown so ein *Fachbegriff*). Bei Erzeugung der HTML-Version des Handbuchs wird die Hervorhebung in einen Tooltip umgewandelt.

Autor*innen-Verzeichnis

Wenn Du etwas beigetragen hast und möchtest, dass Du im Verzeichnis der Autor*innen auftauchst, trage Dich in der YAML-Datei contributors.yml ein. Die Einträge sollten nach Nachname sortiert werden. Die Felder email, position und orcid sind optional.

Technik

Die Master-Version des Handbuch liegt in einem git-Repository unter https://github.com/pro4bib/handbuch-it-in-bibliotheken. Die Ergebnisdateien werden automatisch via GitHub und einen Server der VZG aktualisiert, so dass unter https://it-in-bibliotheken.de/ immer der aktuellste Stand einsehbar sein sollte.

Verzeichnisstruktur

Die Markdown-Dateien im Wurzelverzeichnis (*.md) sind die Masterdateien.

Weitere Unterverzeichnisse:

Die Dateien in folgenden Verzeichnissen sollen nicht per Hand geändert werden:

  • docs/ aus den Masterdateien mit quarto erzeugte Publikation

  • _gdrive/ von bzw. nach Google-Drive importierte bzw. exportierte Kapitel (siehe README.md)

Konvertierung

Zur Anpassung der Konvertierung des Handbuchs mit Quarto muss das Repository lokale geklont und Quarto installiert werden. Für die DOCX-Ausgabe muss außerdem rsvg-convert installiert werden (Paket librsvg2-bin bzw. libsrvg).

Die Aufrufe sind zur Vereinfachung in Makefile zusammengefasst:

  • make preview konvertiert das Handbuch nach HTML und startet einen Webserver mit Vorschau unter http://localhost:15745/ (PLZ von Wildau). Die HTML-Ansicht wird automatisch aktualisiert wenn die Quelldateien lokale geändert werden.

  • make build konvertiert das Handbuch in alle konfigurierten Formate und legt die Ergebnisse im Verzeichnis _book ab. Dieser Schritt wird auch automatisch nach jedem Push auf GitHub ausgeführt.

  • make all ruft make build und docx auf und kopiert die DOCX-Dateien ins Publikationsverzeichnis _book.

  • make html erzeugt nur HTML in _book.

  • make docx erzeugt nur DOCX in _book.

  • make refs aktualisiert das Literaturverzeichnis in references.bib von Zotero.

Lizenz

Alle Beiträge werden unter der Lizenz Creative Commons Namensnennung 3.0 Deutschland (CC BY 3.0 DE) veröffentlicht. Für Abbildungen kann auch eine CC-BY-Lizenz (kein -NC oder -ND) verwendet werden.