Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- FOLIO
- Pisarz techniczny:
- Gallinita
- Nazwa projektu:
- Rozszerzenie dokumentacji aplikacji FOLIO dla użytkowników
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
W ramach tego projektu zamierzam opracować i zaktualizować dokumentację FOLIO przeznaczoną dla użytkowników. Ponieważ FOLIO to system zarządzania biblioteką, użytkownikiem końcowym są pracownicy biblioteki. Obecnie witryna FOLIO wiki (https://wiki.folio.org/) zawiera dokumentację, ale jest ona krótka i nie jest w przystępnym formacie stworzonym z myślą o pracownikach bibliotek. Nowa dokumentacja utworzona w ramach tego projektu będzie przechowywana w bazie wiedzy dotyczącej konkretnej dokumentacji, która będzie dostępna w aplikacjach FOLIO. Będzie zawierać przepływy pracy odpowiednie dla systemu i użytkowników jego biblioteki. Wstępny zestaw dokumentacji zostanie opublikowany w witrynie, począwszy od funkcji rozpowszechniania i rezerwowania kursów. W trakcie tego „długotrwałego” projektu chciałabym w jak największym stopniu wnieść swój wkład w dokumentację.
Podczas rozpatrywania projektu dokumentacji FOLIO udało mi się porozmawiać z Marcią Borensztajn o potrzebach FOLIO i bieżącej sytuacji w dokumentacji. Jak już wspomnieliśmy, dokumentację FOLIO trzeba zaktualizować, rozszerzyć i przeredagować, aby była pomocna dla użytkowników. Należy utworzyć dokumentację odzwierciedlającą standardowe procesy biblioteki, a ponieważ FOLIO składa się z różnych współpracujących ze sobą „aplikacji”, cały system musi być wyjaśniony jako całość. Jestem bibliotekarzem, więc dobrze znam różne scenariusze i przepływy pracy, z którymi mogą się spotykać użytkownicy FOLIO i których potrzebują pomocy. Marcinia pracuje nad utworzeniem nowej bazy wiedzy na temat dokumentacji przy użyciu znaczników Markdown, Git i Hugo. Na podstawie tego projektu zostanie utworzona nowa dokumentacja FOLIO, która posłuży jako podstawa przyszłych działań.