Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- FOLIO
- Redactor técnico:
- gallinita
- Nombre del proyecto:
- Expansión de la documentación para el usuario final de las apps de FOLIO
- Duración del proyecto:
- De larga duración (5 meses)
Project description
Para este proyecto, planeo trabajar en la creación y actualización de la documentación de FOLIO dirigida al usuario final. Dado que FOLIO es un sistema de administración de bibliotecas, el usuario final es el personal de la biblioteca. Actualmente, la wiki de FOLIO (https://wiki.folio.org/) contiene cierta documentación, pero es mínima y no está en un formato fácil de entender creado teniendo en cuenta al personal de la biblioteca. La nueva documentación creada a partir de este proyecto se alojará en una base de conocimiento de documentación específica, a la que se podrá acceder desde las apps de FOLIO, y contendrá flujos de trabajo relevantes para el sistema y los usuarios de su biblioteca. En el sitio, se publicará un conjunto inicial de documentación, comenzando por la funcionalidad de circulación y reservas de cursos. Me gustaría contribuir tanto como pueda con la documentación a lo largo de este proyecto “de larga duración”.
Al analizar el proyecto de documentación FOLIO, hablé con Marcia Borensztajn sobre las necesidades de FOLIO y su situación de documentación actual. Como se mencionó anteriormente, la documentación de FOLIO debe actualizarse, ampliarse y revisarse para ayudar a sus usuarios de manera correcta. Se debe crear documentación para reflejar los procesos de bibliotecas estándar y, dado que FOLIO consta de diferentes “apps” que funcionan en conjunto, se debe explicar el sistema en su totalidad. Como soy bibliotecario, conozco muy bien los tipos de situaciones y flujos de trabajo por los que es probable que atraviesen los usuarios de FOLIO y para los que necesitan ayuda. Marcia está trabajando en la creación de la nueva base de conocimiento de la documentación con Markdown, Git y Hugo. A partir de este proyecto, se creará documentación nueva sobre FOLIO que servirá como marco para el futuro.