Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- FOLIO
- Technischer Redakteur:
- Gallinita
- Projektname:
- Erweiterung der Endnutzerdokumentation für FOLIO-Apps
- Projektdauer:
- Langfristig (5 Monate)
Projektbeschreibung
Für dieses Projekt plane ich, an der Erstellung und Aktualisierung der FOLIO-Dokumentation für die Endanwendenden zu arbeiten. Da FOLIO ein Verwaltungssystem für die Bibliothek ist, handelt es sich beim Endnutzer um Mitarbeiter der Bibliothek. Das FOLIO-Wiki (https://wiki.folio.org/) enthält zwar einige Dokumentationen, diese ist jedoch minimal und nicht leicht verständlich und wurde speziell für Bibliotheksmitarbeiter erstellt. Die aus diesem Projekt erstellte neue Dokumentation wird in einer speziellen Dokumentations-Wissensdatenbank gehostet, auf die über die Anwendungen von FOLIO zugegriffen werden kann. Sie enthält Workflows, die für das System und seine Bibliotheksnutzer relevant sind. Auf der Website wird ein erster Satz von Dokumentationen veröffentlicht, beginnend mit der Funktion „Auflage“ und „Kursreservierungen“. Ich würde im Laufe dieses lang andauernden Projekts gerne so viel wie möglich zur Dokumentation beitragen.
Im Rahmen des FOLIO-Dokumentationsprojekts habe ich mit Marcia Borensztajn über die Anforderungen und die aktuelle Dokumentationssituation von FOLIO gesprochen. Wie bereits erwähnt, muss die FOLIO-Dokumentation aktualisiert, erweitert und überarbeitet werden, um die Nutzenden erfolgreich zu unterstützen. Die Dokumentation muss erstellt werden, um die Prozesse in Standardbibliotheken abzubilden. Da FOLIO aus verschiedenen „Apps“ besteht, die zusammenarbeiten, muss das System als Ganzes erklärt werden. Als Bibliothekar bin ich sehr gut mit den Szenarien und Arbeitsabläufen vertraut, mit denen die Nutzenden von FOLIO wahrscheinlich arbeiten werden und bei denen ich Hilfe benötigen wird. Marcia arbeitet daran, mithilfe von Markdown, Git und Hugo eine neue Wissensdatenbank zur Dokumentation zu erstellen. Im Rahmen dieses Projekts wird eine neue Dokumentation zu FOLIO erstellt, die als Grundlage für die Zukunft dient.