Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- FOLIO
- Rédacteur technique:
- gallinita
- Nom du projet:
- Développement de la documentation sur les applications FOLIO pour les utilisateurs finaux
- Durée du projet:
- Exécution longue (5 mois)
Project description
Pour ce projet, je prévois de travailler à la création et à la mise à jour de la documentation FOLIO ciblant l’utilisateur final. FOLIO étant 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 certaine documentation, mais il est minimal et n'est pas dans un format compréhensible créé pour le personnel de la bibliothèque. La nouvelle documentation créée dans le cadre de ce projet sera hébergée sur une base de connaissances spécifique, accessible depuis les applications de FOLIO, et contenant des workflows pertinents pour le système et les utilisateurs de sa bibliothèque. Un ensemble initial de documents sera publié sur le site, en commençant par la diffusion et la mise à disposition du 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 de FOLIO, j'ai discuté avec Marcia Borensztajn des besoins de FOLIO et de la situation actuelle en matière de documentation. Comme mentionné ci-dessus, la documentation FOLIO doit être mise à jour, développée et retravaillée afin d’aider efficacement ses utilisateurs. La documentation doit être créée pour refléter les processus de bibliothèque standard et, comme FOLIO consiste en différentes « applications » différentes qui fonctionnent ensemble, le système doit être expliqué dans son ensemble. Comme je suis libraire, je connais très bien les types de scénarios et de flux de travail que les utilisateurs de FOLIO sont susceptibles de suivre et pour lesquels ils ont besoin d'aide. Marcia travaille sur la création de la base de connaissances sur la documentation à l'aide de markdown, Git et Hugo. À partir de ce projet, une nouvelle documentation sur FOLIO sera créée et servira de cadre pour l’avenir.