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:
- INCF
- Rédacteur technique:
- hq
- Nom du projet:
- Documents de formation LORIS sur les neurosciences reproductibles ouvertes
- Durée du projet:
- Exécution longue (5 mois)
Project description
I. Abstraite
LORIS (Longitudinal Online Research and Imaging System) est une plate-forme Web de gestion de projets dédiée à la recherche en neuro-imagerie. Elle soutient plusieurs initiatives en science ouverte. La documentation joue un rôle important dans LORIS. Plus précisément, la documentation aide les utilisateurs et les développeurs de LORIS à comprendre les détails des logiciels afin qu'ils puissent mieux utiliser la plateforme ou contribuer au développement logiciel. En attendant, la documentation LORIS devrait également être mise à jour. Ce projet vise à aider LORIS à améliorer sa documentation.
II. État actuel
LORIS utilise actuellement le wiki GitHub, Read the Docs et le site Web LORIS.ca pour héberger toute la documentation. Plus précisément, le wiki GitHub LORIS héberge la plus grande quantité de documentation LORIS, et d'autres tutoriels, présentations, guides utilisateur et tutoriels LORIS sont hébergés sur diverses plateformes . La documentation LORIS actuelle fournit des guides pour les développeurs et les utilisateurs de LORIS, mais elle pourrait bénéficier d'un développement et d'une organisation supplémentaires, en particulier pour les mises à jour de la documentation et les améliorations des détails techniques.
III. Avantages pour la communauté
En améliorant les documents de formation LORIS sur les neurosciences reproductibles ouvertes, les chercheurs et les développeurs bénéficieraient d'un outil plus convivial pour améliorer la collecte de données dans leurs études. Plus précisément, le projet pourra mettre à jour et améliorer la documentation d'installation/configuration de LORIS, ainsi que les supports destinés aux utilisateurs finaux pour former les nouveaux utilisateurs. En outre, le projet vise à faciliter la migration et à mettre à jour la documentation du wiki GitHub LORIS pour accéder à la section "Read the Docs". Pendant ce temps, le projet peut fournir un diagramme de base de données pour communiquer les relations entre les données et améliorer la visualisation de l'architecture. Enfin, ce projet permettra de mettre à jour et d'améliorer le contenu présentant LORIS, son contexte scientifique ouvert et ses cas d'utilisation.
IV. Forces personnelles pour le projet
Au cours des dernières années, j'ai participé à plusieurs projets techniques grâce auxquels j'ai développé une solide expérience en rédaction technique. Plus précisément, j'étais responsable de la rédaction de documentation dans plusieurs projets d'équipe précédents et je pense avoir suffisamment d'expérience dans l'utilisation d'outils de rédaction technique tels que Read the Docs, Sphinx, Mkdocs, markdown, LaTeX, etc. En parallèle, mon expérience d'enseignement des cours de sciences, de technologie, d'ingénierie et de mathématiques m'a également permis d'améliorer mes compétences en communication technique. Les documents de formation LORIS pour des projets ouverts et reproductibles de neurosciences avec l'INCF seraient une excellente occasion pour moi d'appliquer mes techniques de rédaction technique à LORIS. Par ailleurs, le domaine de la neuroimagerie m'intéresse beaucoup et j'ai cherché à y appliquer mes connaissances techniques. Les documents de formation LORIS pour les projets neurosciences reproductibles ouverts et reproductibles de l'INCF m'offriraient une expérience précieuse.
V. Produits livrables
- Migrer et mettre à jour la documentation LORIS actuelle
- Examiner, mettre à jour et améliorer la documentation d'installation/configuration de LORIS, et combler les lacunes dans les documents destinés aux utilisateurs finaux pour former les nouveaux utilisateurs
- Aider à générer un diagramme de base de données pour communiquer les relations entre les données (par exemple, sujet, visite d'étude) et améliorer la visualisation de l'architecture
- Contribuez à mettre à jour et à améliorer la documentation de l'API LORIS
- Contribuer à la mise à jour et à l'amélioration des contenus présentant LORIS, son contexte scientifique ouvert et ses cas d'utilisation, impliquant plusieurs formats de médias
VI. Chronologie
Engagement communautaire (17 août-13 septembre) a) Bien connaître le logiciel LORIS et le flux de travail de l'équipe b) Examiner, mettre à jour et améliorer la documentation d'installation/configuration de LORIS
Semaine 1 (14 septembre - 20 septembre) Mettez à jour et migrez la documentation LORIS depuis le wiki GitHub vers Read the Docs.
Semaine 2 (21 septembre - 27 septembre) a) Passez en revue les supports actuels de LORIS destinés aux utilisateurs finaux. b) Commencer à combler les lacunes dans les supports LORIS destinés aux utilisateurs finaux en formant les nouveaux utilisateurs sur la base de la documentation actuelle.
Semaine 3 (28 septembre - 4 octobre) Complétez les documents de LORIS destinés aux utilisateurs finaux pour les formations destinées aux nouveaux utilisateurs.
Semaine 4 (5 octobre – 11 octobre) a) Comprendre l'architecture de base de données LORIS actuelle. b) Commencer à implémenter le diagramme de base de données pour la plate-forme LORIS.
Semaine 5 (du 12 octobre au 18 octobre) a) Terminer la tâche de génération du diagramme de la base de données LORIS. b) Passer en revue l'API LORIS actuelle et commencer à contribuer à améliorer la documentation de l'API.
Semaine 6 (19 octobre - 25 octobre) Poursuivez vos travaux d'amélioration de la documentation de l'API LORIS.
Semaine 7 (26 octobre - 1er novembre) Terminez l'amélioration de la documentation de l'API LORIS.
Semaine 8 (2 novembre – 8 novembre) Passez en revue les contenus actuels présentant LORIS aux personnes, et commencez à mettre à jour et à améliorer le contexte de la science ouverte.
Semaine 9 (9 novembre – 15 novembre) Terminez les mises à jour et les améliorations du contexte scientifique ouvert dans le cadre de la présentation de LORIS.
Semaine 10 (du 16 novembre au 22 novembre) Contribuez à la mise à jour et à l'amélioration d'une partie des cas d'utilisation dans le contenu de présentation de LORIS.
Semaine 11 (du 23 novembre au 29 novembre) Terminez la mise à jour et l'amélioration de tous les cas d'utilisation dans le contenu de présentation de LORIS.
Finalisation du projet (du 30 novembre au 5 décembre) a) Nettoyez toutes les contributions à la documentation que j'ai créées. b) Fusionnez toutes les demandes d'extraction créées sur GitHub et fermez toutes les erreurs que j'ai créées. c) Finalisez mon rapport final de projet et envoyez le rapport à Google.
VII. Produits livrables futurs
Après la saison Google Docs de 2020, je souhaite continuer à contribuer à la documentation de LORIS. Plus précisément, j'aimerais discuter avec les développeurs LORIS de la possibilité de continuer à mettre à jour et à créer de la documentation pour les nouvelles versions. De plus, j'aimerais prendre le temps d'examiner la documentation que j'ai créée au cours de mon projet Google Season of Docs et vérifier s'il y a plus de marge d'amélioration. Enfin, comme j'ai une formation pertinente en ingénierie, je suis prêt à contribuer à d'autres aspects du logiciel LORIS à l'avenir, par exemple au développement de logiciels.