Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- FOLIO
- Technischer Redakteur:
- gallinita
- Projektname:
- Erweiterung der Dokumentation für Endnutzer von FOLIO-Apps
- Projektlänge:
- Lang andauernd (5 Monate)
Projektbeschreibung
Für dieses Projekt plane ich, FOLIO-Dokumentation für Endnutzer zu erstellen und zu aktualisieren. Da FOLIO ein Bibliotheksverwaltungssystem ist, sind die Endnutzer die Bibliotheksmitarbeiter. Derzeit enthält das FOLIO-Wiki (https://wiki.folio.org/) einige Dokumentationen, die jedoch nur sehr spärlich und nicht in einem für Bibliotheksmitarbeiter verständlichen Format verfügbar sind. Die neue Dokumentation, die im Rahmen dieses Projekts erstellt wird, wird in einer speziellen Dokumentations-Wissensdatenbank gehostet, auf die über die FOLIO-Apps zugegriffen werden kann. Sie enthält Workflows, die für das System und seine Bibliotheksnutzer relevant sind. Auf der Website wird eine erste Reihe von Dokumenten veröffentlicht, beginnend mit den Funktionen für die Ausleihe und Kursreservierungen. Ich möchte im Laufe dieses „langfristigen“ Projekts so viel wie möglich zur Dokumentation beitragen.
Bei der Recherche zum FOLIO-Dokumentationsprojekt habe ich mit Marcia Borensztajn über die Anforderungen von FOLIO und die aktuelle Dokumentationssituation gesprochen. Wie bereits erwähnt, muss die FOLIO-Dokumentation aktualisiert, erweitert und überarbeitet werden, damit sie Nutzern tatsächlich weiterhilft. Es muss eine Dokumentation erstellt werden, die die Standardprozesse der Bibliothek widerspiegelt. Da FOLIO aus verschiedenen „Apps“ besteht, die zusammenarbeiten, muss das System als Ganzes erklärt werden. Da ich selbst Bibliothekarin bin, kenne ich die Arten von Szenarien und Workflows, die die Nutzer von FOLIO wahrscheinlich durchlaufen werden und bei denen sie Hilfe benötigen. Marcia arbeitet daran, mithilfe von Markdown, Git und Hugo die neue Wissensdatenbank zur Dokumentation zu erstellen. Aus diesem Projekt wird neue Dokumentation zu FOLIO erstellt, die als Rahmen für die Zukunft dient.