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:
- INCF
- Redactor técnico:
- hq
- Nombre del proyecto:
- Documentos de capacitación de LORIS para la neurociencia reproducible y abierta
- Duración del proyecto:
- De larga duración (5 meses)
Project description
I. Resumen
El sistema de investigación y visualización en línea longitudinal (LORIS) es una plataforma de administración de proyectos orientada a la Web para la investigación de neuroimagen que admite varias iniciativas de ciencia abierta. La documentación tiene un papel importante en LORIS. Específicamente, la documentación ayuda a los usuarios y desarrolladores de LORIS a comprender los detalles del software para que puedan usar mejor la plataforma o contribuir al desarrollo del software. Mientras tanto, también se debe actualizar la documentación de LORIS. El objetivo de este proyecto es ayudar a LORIS a mejorar su documentación.
II. Estado actual
Actualmente, LORIS usa Github Wiki, Read the Docs y el sitio web LORIS.ca para alojar toda la documentación. Específicamente, la Wiki LORIS de GitHub aloja la mayor cantidad de documentación de LORIS, y se alojan instructivos, presentaciones, guías del usuario y explicaciones adicionales de LORIS en una variedad de plataformas . La documentación actual de LORIS proporciona guías para los desarrolladores y usuarios de LORIS, pero podría beneficiarse de un mayor desarrollo y organización, en especial en las actualizaciones de la documentación y las mejoras en los detalles técnicos.
III. Beneficios para la comunidad
Si se mejoran los documentos de capacitación de LORIS para la neurociencia reproducible abierta, los investigadores y desarrolladores se beneficiarían de una herramienta más fácil de usar para mejorar la recopilación de datos en sus estudios. Específicamente, el proyecto puede actualizar y mejorar la documentación de instalación y configuración de LORIS, así como los materiales para usuarios finales que brindan capacitación a los usuarios nuevos. Además, el objetivo del proyecto es ayudar a migrar y actualizar la documentación de la wiki de GitHub de LORIS a Read the Docs. Mientras tanto, el proyecto puede proporcionar un diagrama de base de datos para comunicar las relaciones de datos y mejorar la visualización de la arquitectura. Por último, este proyecto actualizaría y mejoraría el contenido que presenta LORIS, su contexto de ciencia abierta y sus casos de uso.
IV. Fortalezas personales para el proyecto
En los últimos años, he participado en varios proyectos técnicos mediante los cuales he adquirido conocimientos sólidos de redacción técnica. Específicamente, fui responsable de la redacción de documentación en varios proyectos de equipo anteriores y creo que tengo suficiente experiencia en el uso de herramientas de redacción técnica, como Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX, etcétera. Mientras tanto, mi experiencia previa de enseñanza en cursos de STEM también mejoró mis habilidades de comunicación técnica. Los documentos de capacitación de LORIS para proyectos de neurociencia de reproducción abierta con INCF serían una gran oportunidad para que aplique mis técnicas de escritura técnica a LORIS. Además, me interesa mucho el campo de la neuroimagen y he estado tratando de encontrar oportunidades para aplicar mis conocimientos técnicos a este campo. Los documentos de capacitación de LORIS para proyectos de neurociencia reproducibles y abiertos con INCF serían una experiencia valiosa para mí.
V. Entregas
- Migrar y actualizar la documentación actual de LORIS
- Revisar, actualizar y mejorar la documentación de instalación y configuración de LORIS, y cubrir las brechas en los materiales para usuarios finales que proporcionan capacitación a los usuarios nuevos
- Ayudar a generar un diagrama de base de datos para comunicar las relaciones de datos (p.ej., sujeto, visita de estudio) y mejorar la visualización de la arquitectura
- Ayuda a actualizar y mejorar la documentación de la API de LORIS
- Ayudar a actualizar y mejorar el contenido que presenta LORIS, su contexto de ciencia abierta y sus casos de uso, con varios formatos de contenido multimedia
VI. Cronograma
Vinculación con la comunidad (del 17 de agosto al 13 de septiembre) a) Familiarización completa con el software LORIS y el flujo de trabajo del equipo. b) Revisar, actualizar y mejorar la documentación de instalación y configuración de LORIS.
Semana 1 (del 14 al 20 de septiembre) Actualiza y migra la documentación de LORIS del wiki de GitHub a Read the Docs.
Semana 2 (del 21 al 27 de septiembre) a) Revisa los materiales actuales para usuarios finales de LORIS. b) Comenzar a llenar los vacíos en los materiales para usuarios finales de LORIS a fin de brindar capacitación a los nuevos usuarios en función de la documentación actual.
Semana 3 (del 28 de septiembre al 4 de octubre) Completa los materiales para usuarios finales de LORIS que brindan capacitación a los usuarios nuevos.
Semana 4 (del 5 al 11 de octubre) a) Comprender la arquitectura actual de la base de datos LORIS b) Comenzar a implementar el diagrama de bases de datos para la plataforma LORIS
Semana 5 (del 12 al 18 de octubre) a) Termina la tarea de generación de diagramas de la base de datos de LORIS. b) Revisa la API actual de LORIS y comienza a ayudar a mejorar la documentación de la API.
Semana 6 (del 19 al 25 de octubre) Continúa trabajando en la mejora de la documentación de la API de LORIS.
Semana 7 (del 26 de octubre al 1 de noviembre) Finaliza la mejora en la documentación de la API de LORIS.
Semana 8 (del 2 al 8 de noviembre) Revisa el contenido actual en el que se presenta LORIS a las personas y comienza a actualizarte para mejorar el contexto de ciencia abierta.
Semana 9 (del 9 al 15 de noviembre) Finaliza las actualizaciones y mejoras del contexto de la ciencia abierta en el contenido para presentar LORIS a las personas.
Semana 10 (del 16 al 22 de noviembre) Ayuda a actualizar y mejorar parte de los casos de uso en el contenido que presenta LORIS a las personas.
Semana 11 (del 23 al 29 de noviembre) Finaliza la actualización y mejora de todos los casos de uso en el contenido que presenta LORIS a las personas.
Finalización del proyecto (del 30 de noviembre al 5 de diciembre) a) Limpiar todas las contribuciones de documentación que creé. b) Combinar todas las solicitudes de extracción creadas en GitHub y cerrar todos los problemas que creé. c) Terminar mi informe final del proyecto y enviarlo a Google.
VII. Entregas futuras
Después de la temporada de Documentos de Google 2020, me gustaría continuar mis contribuciones a la documentación de LORIS. En particular, me gustaría hablar con los desarrolladores de LORIS sobre la posibilidad de seguir actualizando y creando documentación para las nuevas versiones. Además, me gustaría dedicar un tiempo adicional a revisar la documentación que creé durante mi proyecto de la Temporada de Documentos de Google y comprobar si hay más espacio para mejorar. Por último, como tengo experiencia relevante en ingeniería, estoy dispuesto a contribuir con otros aspectos del software de LORIS en el futuro, por ejemplo, el desarrollo de software.