Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- FOLIO
- Rédacteur technique:
- gallinita
- Nom du projet:
- Élargissement de la documentation destinée aux utilisateurs finaux des applications FOLIO
- Durée du projet:
- Longue durée (5 mois)
Project description
Pour ce projet, je prévois de créer et de mettre à jour la documentation FOLIO destinée à l'utilisateur final. Comme FOLIO est un système de gestion de bibliothèque, l'utilisateur final est le personnel de la bibliothèque. Actuellement, le wiki FOLIO (https://wiki.folio.org/) contient une documentation, mais elle est minimale et n'est pas présentée dans un format digeste conçu pour le personnel des bibliothèques. La nouvelle documentation créée à partir de ce projet sera hébergée dans une base de connaissances de documentation spécifique, accessible depuis les applications de FOLIO. Elle contiendra des workflows pertinents pour le système et les utilisateurs de sa bibliothèque. Un premier ensemble de documentation sera publié sur le site, à commencer par les fonctionnalités de circulation et de réservation de cours. J'aimerais contribuer autant que possible à la documentation tout au long de ce projet « de longue durée ».
En examinant le projet de documentation FOLIO, j'ai discuté avec Marcia Borensztajn des besoins de FOLIO et de la situation actuelle de la documentation. Comme indiqué ci-dessus, la documentation FOLIO doit être mise à jour, développée et retravaillée pour aider ses utilisateurs. Une documentation doit être créée pour refléter les processus de bibliothèque standard. Comme FOLIO se compose de différentes "applications" qui fonctionnent ensemble, le système doit être expliqué dans son ensemble. En tant que bibliothécaire, je connais très bien les types de scénarios et de workflows que les utilisateurs de FOLIO sont susceptibles de rencontrer et pour lesquels ils ont besoin d'aide. Marcia travaille sur la création de la nouvelle base de connaissances de documentation à l'aide de Markdown, de Git et de Hugo. À partir de ce projet, de nouvelles documentations sur FOLIO seront créées et serviront de référence à l'avenir.