Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- FOLIO
- Escritor técnico:
- gallinita
- Nombre del proyecto:
- Expansión de la documentación para usuarios finales de las apps de FOLIO
- Duración del proyecto:
- Larga duración (5 meses)
Project description
Para este proyecto, pienso 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 esta. Actualmente, la wiki de FOLIO (https://wiki.folio.org/) contiene parte de la documentación, pero es mínima y no está en un formato fácil de digerir creado con el personal de la biblioteca en mente. 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 sus usuarios de la biblioteca. En el sitio, se publicará un conjunto inicial de documentación, comenzando con la circulación y la funcionalidad de reservas de cursos. Me gustaría contribuir tanto como pueda a la documentación a lo largo de este proyecto de "largo plazo".
Con respecto al proyecto de documentación de FOLIO, hablé con Marcia Borensztajn sobre las necesidades y la situación de documentación actual de FOLIO. Como se mencionó anteriormente, la documentación de FOLIO se debe actualizar, expandir y reelaborar para ayudar con éxito a sus usuarios. Se debe crear documentación para reflejar los procesos estándar de la biblioteca y, debido a que FOLIO consta de diferentes "apps" que funcionan juntas, el sistema debe explicarse como un todo. Como soy bibliotecaria, estoy muy familiarizado con los tipos de situaciones y flujos de trabajo por los que probablemente pasarán los usuarios de FOLIO y que necesiten ayuda. Marcia está trabajando para crear la nueva base de conocimiento de la documentación con Markdown, Git y Hugo. A partir de este proyecto, se creará una nueva documentación sobre FOLIO, que servirá como marco para el futuro.