Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- FOLIO
- Technical writer:
- gallinita
- Nome progetto:
- Espansione della documentazione per gli utenti finali delle app FOLIO
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
Nell'ambito di questo progetto, ho in programma di creare e aggiornare la documentazione FOLIO destinata all'utente finale. Poiché FOLIO è un sistema di gestione delle biblioteche, l'utente finale è il personale della biblioteca. Attualmente, il wiki FOLIO (https://wiki.folio.org/) contiene parte della documentazione, ma è minima e non è in un formato comprensibile creato pensando al personale della biblioteca. La nuova documentazione creata a partire da questo progetto sarà ospitata su una specifica knowledge base della documentazione, che sarà accessibile dalle app di FOLIO e conterrà flussi di lavoro pertinenti per il sistema e gli utenti della sua libreria. Sul sito verrà pubblicato un insieme iniziale di documentazione, a partire dalla funzionalità di diffusione e di riserve dei corsi. Vorrei contribuire il più possibile alla documentazione nel corso di questo progetto a "lunga esecuzione".
Nell'esaminare il progetto di documentazione del FOLIO, ho parlato con Marcia Borensztajn delle esigenze di FOLIO e dell'attuale situazione della documentazione. Come accennato in precedenza, la documentazione di FOLIO deve essere aggiornata, ampliata e rielaborata per poter aiutare gli utenti. La documentazione deve essere creata per rispecchiare i processi di libreria standard e, poiché FOLIO è costituito da "app" diverse che funzionano insieme, il sistema deve essere spiegato nel suo complesso. Essendo un bibliotecario, ho molta familiarità con i tipi di scenari e flussi di lavoro che probabilmente gli utenti di FOLIO dovranno affrontare e per cui avranno bisogno di assistenza. Marcia sta lavorando alla creazione di una nuova knowledge base sulla documentazione utilizzando Markdown, Git e Hugo. Da questo progetto verrà creata una nuova documentazione su FOLIO che fungerà da framework per il futuro.