Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- FOLIO
- Redattore tecnico:
- gallinita
- Nome del progetto:
- Espansione della documentazione per gli utenti finali delle app FOLIO
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
Per questo progetto, ho intenzione di lavorare alla creazione e all'aggiornamento della documentazione di FOLIO rivolta all'utente finale. Poiché FOLIO è un sistema di gestione della biblioteca, l'utente finale è il personale della biblioteca. Al momento, la wiki di FOLIO (https://wiki.folio.org/) contiene alcune informazioni, ma sono minime e non sono in un formato facilmente comprensibile creato pensando al personale delle biblioteche. La nuova documentazione creata in questo progetto verrà ospitata in una knowledge base di documentazione specifica, accessibile dalle app di FOLIO, e conterrà flussi di lavoro pertinenti al sistema e agli utenti della biblioteca. Sul sito verrà pubblicata una serie iniziale di documentazione, a partire dalla funzionalità di circolazione e prenotazione dei corsi. Vorrei dare il mio contributo alla documentazione nel corso di questo progetto "lungo".
Nell'esaminare il progetto di documentazione di FOLIO, ho parlato con Marcia Borensztajn delle esigenze di FOLIO e della situazione attuale della documentazione. Come accennato in precedenza, la documentazione di FOLIO deve essere aggiornata, ampliata e rielaborata per aiutare gli utenti. È necessario creare la documentazione per rispecchiare le procedure standard della biblioteca e, poiché FOLIO è costituito da diverse "app" che funzionano insieme, il sistema deve essere spiegato nel suo complesso. Dato che sono un bibliotecario, conosco molto bene i tipi di scenari e flussi di lavoro che gli utenti di FOLIO probabilmente affronteranno e per i quali avranno bisogno di assistenza. Marcia sta lavorando alla creazione della nuova knowledge base della documentazione utilizzando Markdown, Git e Hugo. Da questo progetto verrà creata nuova documentazione su FOLIO che fungerà da framework per il futuro.