Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- INCF
- Redattore tecnico:
- hq
- Nome progetto:
- Documentazione sull'addestramento di LORIS per la neuroscienza aperta e riproducibile
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
I. Abstract
Il Longitudinal Online Research and Imaging System (LORIS) è una piattaforma di gestione dei progetti rivolta al web per la ricerca di neuroimaging,che supporta diverse iniziative di Open Science. La documentazione gioca un ruolo importante in LORIS. Nello specifico, la documentazione aiuta gli utenti e gli sviluppatori di LORIS a comprendere i dettagli del software in modo da poter utilizzare meglio la piattaforma o contribuire allo sviluppo del software. Nel frattempo, dovrebbe essere aggiornata anche la documentazione di LORIS. Questo progetto mira ad aiutare LORIS a migliorare la sua documentazione.
II. Stato attuale
LORIS attualmente utilizza il wiki GitHub, legge i documenti e il sito web LORIS.ca per ospitare tutta la documentazione. Nello specifico, la wiki di GitHub di LORIS ospita la maggior parte della documentazione di LORIS, mentre altri tutorial, presentazioni, guide utente e procedure dettagliate di LORIS sono ospitati su una serie di piattaforme . L'attuale documentazione di LORIS fornisce guide per gli sviluppatori e gli utenti di LORIS, ma potrebbe trarre vantaggio da un ulteriore sviluppo e organizzazione, in particolare per gli aggiornamenti della documentazione e i miglioramenti dei dettagli tecnici.
III. Vantaggi per la community
Migliorando la documentazione di formazione di LORIS per la neuroscienza aperta e riproducibile, ricercatori e sviluppatori potranno usufruire di uno strumento più intuitivo per migliorare la raccolta dei dati nei loro studi. Nello specifico, il progetto potrebbe aggiornare e migliorare la documentazione di installazione/configurazione di LORIS, nonché i materiali per gli utenti finali che forniscono formazione ai nuovi utenti. Inoltre, il progetto punterà ad agevolare la migrazione e l'aggiornamento della documentazione dal wiki LORIS su GitHub a leggere la documentazione. Nel frattempo, il progetto potrebbe fornire un diagramma del database per comunicare le relazioni tra i dati e migliorare la visualizzazione dell'architettura. Infine, questo progetto aggiornerebbe e migliorerebbe i contenuti presentando alle persone LORIS, il suo contesto scientifico aperto e i suoi casi d'uso.
IV. Punti di forza personali per il progetto
Negli ultimi anni ho partecipato a diversi progetti tecnici, grazie ai quali ho sviluppato una solida esperienza nella scrittura tecnica. Nello specifico, in passato mi sono occupato di scrivere la documentazione in più progetti di gruppo e ritengo di avere sufficiente esperienza nell'utilizzo di strumenti di scrittura tecnica come Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX e così via. Nel frattempo, la mia precedente esperienza di insegnamento in corsi STEM ha migliorato anche le mie competenze nella comunicazione tecnica. I documenti di formazione di LORIS per progetti di neuroscienza riproducibili aperti con INCF sarebbero un'ottima opportunità per applicare le mie tecniche di scrittura tecnica a LORIS. Inoltre, sono molto interessato al campo della neuroimmagine e sto cercando opportunità per applicare le mie conoscenze tecniche a questo campo. I documenti di formazione di LORIS per progetti di neuroscienze aperti e riproducibili con l'INCF rappresentano un'esperienza preziosa per me.
V. Risultati attesi
- Eseguire la migrazione e aggiornare la documentazione attuale di LORIS
- Rivedi, aggiorna e migliora la documentazione di installazione/configurazione di LORIS e colma le lacune nei materiali per gli utenti finali fornendo formazione per i nuovi utenti
- Contribuire a generare un diagramma del database per comunicare le relazioni tra i dati (ad es. soggetto, visita di studio) e migliorare la visualizzazione dell'architettura
- Contribuisci ad aggiornare e migliorare la documentazione dell'API LORIS
- Contribuisci ad aggiornare e migliorare i contenuti presentando LORIS, il suo contesto scientifico aperto e i suoi casi d'uso, che coinvolgono diversi formati multimediali
VI. Cronologia
Legame con la community (17 agosto - 13 settembre) a) Completare familiarità con il software LORIS e con il flusso di lavoro del team. b) Esaminare, aggiornare e migliorare la documentazione di installazione/configurazione di LORIS.
Settimana 1 (14-20 settembre) Aggiorna e esegui la migrazione della documentazione di LORIS dalla wiki di GitHub a Read the Docs.
Seconda settimana (21-27 settembre) a) Esamina i materiali attuali per gli utenti finali di LORIS. b) Iniziare a colmare le lacune nei materiali per gli utenti finali di LORIS fornendo formazione ai nuovi utenti in base alla documentazione attuale.
Terza settimana (28 settembre - 4 ottobre) Completa le lacune nei materiali per gli utenti finali di LORIS fornendo formazione per i nuovi utenti.
Settimana 4 (5 ottobre - 11 ottobre) a) Comprensione dell'architettura attuale del database LORIS. b) Iniziare a implementare il diagramma di database per la piattaforma LORIS.
Settimana 5 (12 ottobre - 18 ottobre) a) Completa l'attività di generazione del diagramma del database LORIS. b) Rivedi l'API LORIS attuale e inizia a migliorare la documentazione dell'API.
Settimana 6 (19-25 ottobre) Continuiamo a lavorare al miglioramento della documentazione dell'API LORIS.
Settimana 7 (26 ottobre - 1° novembre) Completamento del miglioramento della documentazione dell'API LORIS.
Settimana 8 (2-8 novembre) Esamina i contenuti attuali che introducono le persone a LORIS e inizia ad aggiornare e migliorare il contesto della scienza aperta.
Settimana 9 (9-15 novembre) Completa gli aggiornamenti e i miglioramenti del contesto della scienza aperta nei contenuti di introduzione a LORIS.
Settimana 10 (16-22 novembre) Contribuisci ad aggiornare e migliorare parte dei casi d'uso nei contenuti che introducono LORIS.
Settimana 11 (23-29 novembre) Completa l'aggiornamento e il miglioramento di tutti i casi d'uso nei contenuti che introducono LORIS.
Finalizzazione del progetto (30 novembre - 5 dicembre) a) Ripulire tutti i contributi alla documentazione che ho creato. b) Unisci tutte le richieste pull create su GitHub e chiudi tutti i problemi che ho creato. c) Completa il report finale del progetto e invialo a Google.
VII. Risultati futuri
Dopo la Stagione dei documenti di Google 2020, vorrei continuare a contribuire alla documentazione di LORIS. In particolare, vorrei discutere con gli sviluppatori di LORIS sulla possibilità di continuare ad aggiornare e creare la documentazione per le nuove release. Inoltre, vorrei prendermi un po' di tempo in più per rivedere la documentazione che ho creato durante il mio progetto Google Season of Docs e verificare se c'è spazio per ulteriori miglioramenti. Infine, dato che ho una formazione ingegneristica pertinente, sono disposto a contribuire in futuro ad altri aspetti del software LORIS, ad esempio lo sviluppo del software.