Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- FOLIO
- Pisarz techniczny:
- gallinita
- Nazwa projektu:
- Rozszerzenie dokumentacji dla użytkowników aplikacji FOLIO
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
W ramach tego projektu planuję tworzyć i aktualizować dokumentację FOLIO przeznaczoną dla użytkowników końcowych. FOLIO to system zarządzania biblioteką, więc użytkownikiem końcowym jest personel biblioteki. Obecnie wiki FOLIO (https://wiki.folio.org/) zawiera pewną dokumentację, ale jest ona minimalna i nie jest w przystępnym formacie stworzonym z myślą o pracownikach bibliotek. Nowa dokumentacja utworzona w ramach tego projektu będzie hostowana w specjalnej bazie wiedzy, która będzie dostępna z aplikacji FOLIO i zawierać będzie przepływy pracy istotne dla systemu i jego użytkowników. Na stronie zostanie opublikowany początkowy zestaw dokumentacji, zaczynając od funkcji rezerwacji kursów i obiegu. Chcę jak najbardziej przyczynić się do dokumentacji tego „długotrwałego” projektu.
W sprawie projektu dokumentacji FOLIO rozmawiałam z Marcią Borensztajn o potrzebach tej organizacji i obecnej sytuacji dotyczącej dokumentacji. Jak już wspomnieliśmy, dokumentacja FOLIO wymaga zaktualizowania, rozszerzenia i przerobienia, aby była przydatna dla użytkowników. Dokumentacja musi odzwierciedlać standardowe procesy biblioteki, a ponieważ FOLIO składa się z różnych „aplikacji”, które współpracują ze sobą, system musi być opisany jako całość. Jestem bibliotekarzem i bardzo dobrze znam scenariusze oraz przepływy pracy, z którymi użytkownicy FOLIO będą się prawdopodobnie spotykać i w których będą potrzebować pomocy. Marcia pracuje nad utworzeniem nowej bazy wiedzy dokumentacji za pomocą Markdowna, Git i Hugo. W ramach tego projektu zostanie utworzona nowa dokumentacja FOLIO, która posłuży jako ramy dla przyszłych działań.