Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- INCF
- Technical writer:
- hq
- Nome progetto:
- Documenti di formazione LORIS per neuroscienze riproducibili aperte
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
I. Abstract
Il sistema Longitudinal Online Research and Imaging (LORIS) è una piattaforma di gestione di progetti rivolta al web per la ricerca di neuroimaging,a sostegno di diverse iniziative di open science. La documentazione svolge un ruolo importante nel processo LORIS. In particolare, la documentazione aiuta gli utenti e gli sviluppatori di LORIS a comprendere i dettagli del software in modo che possano utilizzare meglio la piattaforma o contribuire allo sviluppo del software. Nel frattempo, dovrebbe essere aggiornata anche la documentazione relativa al LORIS. Questo progetto ha lo scopo di aiutare LORIS a migliorare la propria documentazione.
II. Stato attuale
Attualmente LORIS utilizza il Wiki di GitHub, la sezione Leggi i documenti e il sito web LORIS.ca per ospitare tutta la documentazione. Nello specifico, il Wiki GitHub di LORIS ospita la più grande quantità di documentazione LORIS, mentre ulteriori tutorial, presentazioni, guide per l'utente e procedure dettagliate relative a LORIS sono ospitati in una varietà di piattaforme . L'attuale documentazione di LORIS fornisce guide per gli sviluppatori e gli utenti LORIS, ma potrebbe trarre vantaggio da un ulteriore sviluppo e organizzazione, soprattutto negli aggiornamenti della documentazione e nei miglioramenti dei dettagli tecnici.
III. Vantaggi per la community
Migliorando i documenti di formazione LORIS per le neuroscienze riproducibili aperte, ricercatori e sviluppatori potrebbero trarre vantaggio da uno strumento più facile da usare, per migliorare la raccolta dei dati nei loro studi. In particolare, il progetto potrebbe aggiornare e migliorare la documentazione di installazione/configurazione di LORIS, nonché materiali per gli utenti finali che forniscono formazione ai nuovi utenti. Lo scopo del progetto è inoltre facilitare la migrazione e aggiornare la documentazione dal wiki GitHub di LORIS alla lettura dei documenti. Nel frattempo, il progetto potrebbe fornire un diagramma di database per comunicare le relazioni tra i dati e migliorare la visualizzazione dell'architettura. Infine, questo progetto aggiorna e migliora i contenuti presentando alle persone lo studio LORIS, il contesto della scienza aperta e i casi d'uso.
IV. Punti di forza personali per il progetto
Negli ultimi anni, ho partecipato a diversi progetti tecnici attraverso i quali ho sviluppato una solida esperienza in scrittura tecnica. Nello specifico, ero responsabile della scrittura di documenti in diversi progetti passati del team e credo di avere sufficiente esperienza nell'uso di strumenti di scrittura tecnica come Read the Docs, Sphinx, Mkdocs, markdown, LaTeX ecc. Nel frattempo, la mia precedente esperienza di insegnamento nei corsi di Scienze, tecnologia, ingegneria e matematica (STEM) ha migliorato anche le mie capacità di comunicazione tecnica. I documenti di formazione LORIS per progetti di neuroscienze a riproducibilità aperti in collaborazione con INCF sarebbero per me un'ottima opportunità per applicare le mie tecniche di scrittura tecnica a LORIS. Inoltre, sono molto interessato al campo del neuroimaging e sto cercando di trovare opportunità per applicare le mie conoscenze tecniche a questo campo. I documenti di formazione LORIS per progetti di neuroscienze aperte e riproducibili con l'INF sarebbero un'esperienza preziosa per me.
V. Materiali da produrre
- Eseguire la migrazione e aggiornare la documentazione LORIS corrente
- Esamina, aggiorna e migliora la documentazione di installazione/configurazione di LORIS e colma le lacune nei materiali per gli utenti finali fornendo formazione ai nuovi utenti
- Aiuta a generare un diagramma di database per comunicare le relazioni tra i dati (ad es. oggetto, 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 che presentano alle persone il LORIS, il suo contesto scientifico aperto e i suoi casi d'uso, che includono diversi formati multimediali
VI. Sequenza
Community Bonding (17 agosto - 13 settembre) a) Familiarizzazione completa con il software LORIS e il flusso di lavoro del team. b) Esamina, aggiorna e migliora la documentazione di installazione/configurazione di LORIS.
Settimana 1 (14 settembre - 20 settembre) Aggiorna ed esegui la migrazione della documentazione LORIS dal wiki GitHub a Leggi la documentazione.
Settimana 2 (21 settembre - 27 settembre) a) Rivedi i materiali correnti per gli utenti finali LORIS. b) Inizia a colmare le lacune nei materiali per gli utenti finali LORIS, fornendo formazione ai nuovi utenti in base alla documentazione corrente.
Settimana 3 (28 settembre - 4 ottobre) Colma le lacune nei materiali per gli utenti finali LORIS fornendo formazione ai nuovi utenti.
Settimana 4 (5 - 11 ottobre) a) Comprendere l'attuale architettura del database LORIS. b) Iniziare a implementare il diagramma del database per la piattaforma LORIS.
Settimana 5 (12 - 18 ottobre) a) Completa l'attività di generazione del diagramma del database LORIS. b) Esamina l'API LORIS attuale e inizia a contribuire a migliorare la relativa documentazione.
Settimana 6 (19 - 25 ottobre) Continua a lavorare al miglioramento della documentazione dell'API LORIS.
Settimana 7 (26 ottobre - 1° novembre) Completa i miglioramenti alla documentazione dell'API LORIS.
Settimana 8 (2-8 novembre) Esamina i contenuti attuali che presentano LORIS alle persone e inizia ad aggiornare e a migliorare il contesto delle scienze aperte.
Settimana 9 (9-15 novembre) Termina gli aggiornamenti e i miglioramenti del contesto delle scienze aperte nei contenuti che introducono le persone a LORIS.
Settimana 10 (16 novembre - 22 novembre) Aiuta ad aggiornare e migliorare parte dei casi d'uso nei contenuti che introducono le persone a LORIS.
Settimana 11 (23 novembre - 29 novembre) Termina l'aggiornamento e il miglioramento di tutti i casi d'uso nei contenuti che introducono le persone a LORIS.
Finalizzazione del progetto (30 novembre - 5 dicembre) a) Ripulisci tutti i contributi alla documentazione che ho creato. b) Unisci tutte le richieste di pull create su GitHub e chiudi tutti i problemi che ho creato. c) Completa la segnalazione finale del progetto e inviala a Google.
VII. Materiali da produrre futuri
Dopo la stagione dei documenti Google 2020, vorrei continuare a contribuire alla documentazione per LORIS. Nello specifico, vorrei discutere con gli sviluppatori LORIS della possibilità di continuare ad aggiornare e creare la documentazione per le nuove release. Inoltre, vorrei dedicare un po' di tempo in più a esaminare la documentazione che ho creato durante il mio progetto per la stagione dei documenti Google per verificare se c'è altro margine di miglioramento. Infine, dato che ho un background ingegneristico, sono disponibile a contribuire ad altri aspetti del software LORIS in futuro, ad esempio lo sviluppo del software.