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:
- INCF
- Escritor técnico:
- hq
- Nombre del proyecto:
- Documentos sobre entrenamiento de LORIS para una neurociencia abierta y reproducible
- Duración del proyecto:
- Larga duración (5 meses)
Project description
I. Se puede abstraer
El Sistema de Investigación e Imágenes Longitudinal en Línea (LORIS) es una plataforma de gestión de proyectos orientada a la Web para la investigación de neuroimágenes,que respalda varias iniciativas de Open Science. La documentación desempeña 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 de software. Mientras tanto, la documentación de LORIS también debería actualizarse. El objetivo de este proyecto es ayudar a LORIS a mejorar su documentación.
II. Estado actual
Actualmente, LORIS usa la Wiki de GitHub, lee los documentos y el sitio web LORIS.ca para alojar toda la documentación. Específicamente, LORIS GitHub Wiki aloja la mayor cantidad de documentación de LORIS, y los tutoriales, presentaciones, guías del usuario y explicaciones adicionales de LORIS se alojan en una variedad de plataformas . La documentación actual de LORIS proporciona guías para desarrolladores y usuarios de LORIS, pero podría beneficiarse con un mayor desarrollo y organización, especialmente en las actualizaciones de documentación y las mejoras en detalles técnicos.
III. Beneficios para la comunidad
Al mejorar los documentos de entrenamiento de LORIS para una neurociencia abierta y reproducible, 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 será ayudar a migrar y actualizar la documentación de la wiki de LORIS en GitHub para poder leer los documentos. Mientras tanto, el proyecto puede proporcionar un diagrama de base de datos para comunicar las relaciones de los datos y mejorar la visualización de la arquitectura. Por último, este proyecto actualizará y mejorará el contenido que presenta a las personas sobre LORIS, su contexto de ciencia abierta y sus casos de uso.
IV. Fortalezas personales para el proyecto
En los últimos años, participé en varios proyectos técnicos con los que he desarrollado una sólida experiencia en escritura técnica. Específicamente, fui responsable de la redacción de documentación en varios proyectos anteriores en equipo y creo que tengo suficiente experiencia en el uso de herramientas de escritura técnica, como Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX, etc. Mientras tanto, mi experiencia docente anterior en cursos de CTIM también mejoró mis habilidades en comunicación técnica. Los documentos de entrenamiento de LORIS para proyectos de neurociencias reproducibles y abiertos con INCF serían una gran oportunidad para que aplique mis técnicas de escritura técnica a LORIS. Además, estoy muy interesado en el campo de las neuroimágenes y estoy intentando encontrar oportunidades para aplicar mis conocimientos técnicos. Los documentos de entrenamiento de LORIS para proyectos de neurociencia abierta y reproducible con INCF serían una experiencia valiosa para mí.
V. Ítems
- 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 llenar los vacíos en los materiales para usuarios finales que brindan capacitación a los usuarios nuevos
- Ayudar a generar un diagrama de base de datos para comunicar las relaciones entre los datos (p.ej., sujeto, visita del estudio) y mejorar la visualización de la arquitectura
- Ayuda a actualizar y mejorar la documentación de la API de LORIS
- Ayuda a actualizar y mejorar el contenido que presenta a las personas a LORIS, su contexto de ciencia abierta y sus casos de uso, en los que se incluyen múltiples formatos de medios.
VI. Cronograma
Vinculación de la comunidad (del 17 de agosto al 13 de septiembre) a) Familiarizarse con el software de 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 de la wiki de GitHub para leer los documentos.
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, lo que brinda capacitación para los usuarios nuevos en función de la documentación actual.
Semana 3 (del 28 de septiembre al 4 de octubre) Termina de completar los vacíos de información para completar los materiales para usuarios finales de LORIS y brindar capacitaciones a los usuarios nuevos.
Semana 4 (5 de octubre al 11 de octubre) a) Comprende la arquitectura actual de la base de datos de LORIS. b) Comenzar a implementar el diagrama de base de datos para la plataforma de LORIS.
Semana 5 (del 12 de octubre al 18 de octubre) a) Finalizar la tarea de generación del diagrama de la base de datos de LORIS. b) Revisar la API de LORIS actual y comenzar a ayudar a mejorar la documentación de la API.
Semana 6 (del 19 al 25 de octubre) Sigue trabajando para mejorar la documentación de la API de LORIS.
Semana 7 (del 26 de octubre al 1 de noviembre) Termina de mejorar la documentación de la API de LORIS.
Semana 8 (del 2 de noviembre al 8 de noviembre) Revisa el contenido actual en el que se presenta LORIS a las personas y comienza a actualizarlos y mejorar el contexto de la ciencia abierta.
Semana 9 (9 de noviembre - 15 de noviembre) Finaliza las actualizaciones y mejoras del contexto de ciencia abierta en el contenido de la presentación de 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 a las personas sobre LORIS.
Semana 11 (del 23 al 29 de noviembre) Finaliza la actualización y mejora de todos los casos de uso en el contenido para presentar LORIS a las personas.
Finalización del proyecto (del 30 de noviembre al 5 de diciembre) a) Borrar todas las contribuciones de documentación que creé
VII. Entregas futuras
Después de la temporada de Documentos de Google 2020, me gustaría seguir con mis contribuciones a la documentación de LORIS. Específicamente, me gustaría conversar con los desarrolladores de LORIS sobre la posibilidad de seguir actualizando y creando documentación para los nuevos lanzamientos. Además, me gustaría tomarme un tiempo adicional para revisar la documentación que creé durante mi proyecto de la temporada de Documentos de Google y ver si hay más espacio para mejorar. Por último, dado que tengo formación en ingeniería relevante, estoy dispuesto a contribuir en otros aspectos del software de LORIS en el futuro, como el desarrollo de software.