Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- INCF
- Rédacteur technique:
- hq
- Nom du projet:
- Documentation de formation sur LORIS pour les neurosciences ouvertes et reproductibles
- Durée du projet:
- Longue durée (5 mois)
Project description
I. Extrait
Le système de recherche et d'imagerie en ligne longitudinal (LORIS) est une plate-forme de gestion de projet Web pour la recherche en neuroimagerie,qui s'appuie sur plusieurs initiatives Open Science. La documentation joue un rôle important dans LORIS. Plus précisément, la documentation aide les utilisateurs et les développeurs LORIS à comprendre les détails des logiciels afin qu'ils puissent mieux utiliser la plate-forme ou contribuer au développement du logiciel. En attendant, la documentation LORIS doit également être mise à jour. Ce projet vise à aider LORIS à améliorer sa documentation.
II. État actuel
LORIS utilise actuellement Github Wiki, Read the Docs et le site Web LORIS.ca pour héberger toute la documentation. Plus précisément, le wiki GitHub de LORIS héberge la plus grande quantité de documentation LORIS. Des tutoriels, présentations, guides utilisateur et procédures supplémentaires sont hébergés sur diverses plates-formes. La documentation LORIS actuelle fournit des guides aux développeurs et aux utilisateurs LORIS, mais elle pourrait bénéficier d'un développement et d'une organisation supplémentaires, en particulier pour la mise à jour de la documentation et l'amélioration des détails techniques.
III. Avantages pour la communauté
En améliorant les documents de formation LORIS pour 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 peut mettre à jour et améliorer la documentation d'installation/configuration de LORIS, ainsi que les supports destinés aux utilisateurs finaux pour les former aux nouveaux utilisateurs. De plus, le projet vise à faciliter la migration de la documentation du wiki GitHub LORIS et à la mettre à jour vers la page "Lire les documents". En attendant, 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 vise à mettre à jour et à améliorer les contenus qui présentent LORIS, son contexte de science ouverte et ses cas d'utilisation.
IV. Points forts personnels pour le projet
Au cours des dernières années, j'ai participé à plusieurs projets techniques, ce qui m'a permis de développer une solide expérience en rédaction technique. Plus précisément, j'étais responsable de la rédaction de la documentation dans plusieurs projets en équipe. Je pense que j'ai suffisamment d'expérience dans l'utilisation d'outils d'écriture technique tels que Read the Docs, Sphinx, Mkdocs, markdown, LaTeX, etc. En outre, mon expérience d'enseignement dans des cours STEM m'a également permis d'améliorer mes compétences en communication technique. Les documents de formation LORIS pour les projets de neurosciences reproductibles ouverts avec l'INCF me permettraient d'appliquer mes techniques d'écriture technique à LORIS. De plus, je m'intéresse beaucoup au domaine de la neuroimagerie et j'essaie de trouver des opportunités d'appliquer mes connaissances techniques à ce domaine. Les documents de formation LORIS pour les projets neurosciences reproductibles ouverts avec l'INF m'offriraient une expérience précieuse.
V. Livrables
- Migrer et mettre à jour la documentation actuelle de LORIS
- Examiner, mettre à jour et améliorer la documentation d'installation/configuration de LORIS, et combler les lacunes dans les supports destinés aux utilisateurs finaux pour la formation des nouveaux utilisateurs
- Contribuer à générer un diagramme de base de données pour communiquer les relations entre les données (par exemple, le sujet, la visite d'étude) et améliorer la visualisation de l'architecture
- Contribuer à mettre à jour et à améliorer la documentation de l'API LORIS
- Aider à mettre à jour et à améliorer les contenus qui présentent LORIS, son contexte de science ouverte et ses cas d'utilisation, en utilisant plusieurs formats multimédias
VI. Chronologie
Renforcement des liens communautaires (17 août - 13 septembre) a) Familiarisation complète avec le logiciel LORIS et le workflow en équipe. b) Examen, mise à jour et amélioration de la documentation d'installation/configuration de LORIS.
Semaine 1 (14 au 20 septembre) Mettre à jour et migrer la documentation LORIS du wiki GitHub vers Read the Docs.
Semaine 2 (21 septembre - 27 septembre) a) Examiner les documents LORIS actuels pour les utilisateurs finaux. b) Commencer à combler les lacunes dans les supports LORIS destinés aux utilisateurs finaux en les formant sur la base de la documentation actuelle.
Semaine 3 (28 septembre - 4 octobre) Complétez les lacunes en remplissant les documents destinés aux utilisateurs finaux de LORIS, qui fournissent une formation aux nouveaux utilisateurs.
Semaine 4 (5 au 11 octobre) a) Comprendre l'architecture actuelle de la base de données LORIS. b) Commencer à implémenter le diagramme de la base de données pour la plate-forme LORIS.
Semaine 5 (12 au 18 octobre) a) Terminez la tâche de génération du diagramme de la base de données LORIS. b) Passez en revue l'API LORIS actuelle et commencez à améliorer sa documentation.
Semaine 6 (19 au 25 octobre) Poursuite du travail d'amélioration de la documentation de l'API LORIS.
Semaine 7 (26 octobre – 1er novembre) Terminer l'amélioration de la documentation de l'API LORIS.
Semaine 8 (2 au 8 novembre) Révisez le contenu actuel qui présente LORIS et commencez à mettre à jour et à améliorer le contexte de la science ouverte.
Semaine 9 (du 9 novembre au 15 novembre) Terminez les mises à jour et les améliorations du contexte de la science ouverte dans le contenu de présentation de LORIS.
Semaine 10 (16 novembre – 22 novembre) Aidez à mettre à jour et à améliorer une partie des cas d'utilisation dans les contenus de présentation de LORIS.
Semaine 11 (23 au 29 novembre) Terminez la mise à jour et l'amélioration de tous les cas d'utilisation dans les contenus présentant LORIS.
Finalisation du projet (du 30 novembre au 5 décembre) a) Effacer toutes les contributions à la documentation que j'ai créées. b) Fusionner toutes les demandes d'extraction créées sur GitHub et résoudre tous les problèmes que j'ai créés. c) Terminer mon rapport final sur le projet et l'envoyer à Google
VII. Livrables futurs
Après la Google Season of Docs 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 la documentation pour les nouvelles versions. De plus, je souhaite prendre un peu plus de temps pour examiner la documentation que j'ai créée lors de mon projet Google Season of Docs et voir s'il y a encore des améliorations à apporter. Enfin, comme j'ai une formation pertinente en ingénierie, je suis prêt à contribuer à d'autres aspects du logiciel LORIS à l'avenir, comme le développement de logiciels.