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
- Technical Writer:
- Ogbonoko
- Nome del progetto:
- Il metodo di Turing: una guida illustrativa alla data science
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Introduzione
La crescente popolarità della data science e la versatilità delle sue applicazioni lo hanno reso un dominio interessante per studenti, ricercatori, esperti del settore e professionisti in vari campi e livelli di competenza. Per favorire la crescita nel settore, è fondamentale che la ricerca in data science sia e rimanga accessibile alla più ampia community di appassionati di data science. Un modo per raggiungere questo obiettivo è tramite guide su come condurre ricerche di scienza dei dati riproducibili, riutilizzabili e collaborative.
The Turing Way è una di queste guide, con la missione di "garantire che la scienza dei dati riproducibile sia "troppo facile da non fare"". Attualmente, The Turing Way contiene contenuti che riguardano la ricerca riproducibile, la progettazione del progetto, la comunicazione, la collaborazione e la ricerca etica. Tuttavia, con l'espansione dell'ambito di The Turing Way, sarà necessario un supporto editoriale per incorporare contenuti di nuova creazione nel corpo di lavoro esistente.
Obiettivi del progetto
A grandi linee, il mio compito come Technical Writer in questo progetto è rendere The Turing Way più accessibile alla community di data science:
Rivedere i capitoli esistenti di The Turing Way, cercando modi per migliorarne il linguaggio e la struttura,
Incorporare nuovi contenuti nella produzione esistente mantenendo lo stile e il tono generale di The Turing Way coerenti e
Contribuire con nuovi contenuti sotto forma di nuovi capitoli, tutorial interattivi e/o case study.
Cronologia
In caso di esito positivo della mia domanda, propongo di completare il progetto nel seguente modo:
Entro il 17 agosto:
Contribuire a The Turing Way, ove possibile (correzione di errori ortografici e così via)
Acquisire familiarità con le informazioni attuali contenute in The Turing Way
Migliorare le mie capacità di scrittura e di editing, oltre ad acquisire familiarità con gli strumenti con cui lavorerò.
Fase di creazione di legami con la community (17 agosto - 23 settembre):
Interagisci in modo proattivo con il team/la community responsabile di The Turing Way e scopri di più sul progetto.
Stabilire e mantenere attivi i canali di comunicazione con i mentor.
Perfeziona e finalizza gli obiettivi del progetto con il contributo dei mentori e della comunità in generale.
Settimana 1 (14-19 settembre)
La prima settimana sarà dedicata agli strumenti necessari per assicurare la mia produttività.
Inoltre, ho scoperto alcuni errori ortografici durante la lettura di The Turing Way. Tuttavia, intendo correggere questi errori prima del 17 agosto, in quanto contribuisco al progetto. Ti propongo di dedicare le prime settimane all'esame dei capitoli esistenti del libro per assicurarti che la grammatica, l'ortografia e il tono siano corretti, coerenti e accattivanti per il pubblico di destinazione del progetto.
Inizierò la fase di correzione con il capitolo intitolato Guida per la ricerca riproducibile.
Settimana 2 (20-26 settembre)
Correggere e modificare il capitolo intitolato Guida alla progettazione del progetto e qualsiasi nuovo contributo di contenuti, consigliando le modifiche necessarie.
Settimana 3 (27 settembre - 3 ottobre)
Correggere e modificare il capitolo Guida alla comunicazione.
Settimana 4 (4-10 ottobre)
Correggere e modificare il capitolo Guida alla collaborazione e inviare nuovi contributi di contenuti.
Settimana 5 (11 ottobre - 17 ottobre)
Correggere e modificare il capitolo intitolato Guida alla ricerca etica e eventuali nuovi contributi di contenuti.
Settimana 6 (18 ottobre - 24 ottobre)
Correggere e modificare il capitolo intitolato Guida alla progettazione del progetto ed eventuali nuovi contributi di contenuti.
Settimana 7 (25 ottobre - 31 ottobre)
Raccogli idee e crea nuovi contenuti per The Turing Way con il contributo dei mentori del progetto. Questi nuovi contenuti potrebbero essere sotto forma di un nuovo capitolo, un tutorial o un case study. Ad esempio, al momento sto lavorando allo sviluppo di metodi per il recupero e la comprensione dei podcast nell'ambito della mia tesi di dottorato. Ho potuto documentare questa esperienza e i miei risultati di apprendimento come case study.
Settimane 8-10 (1° novembre - 28 novembre)
Completa la documentazione dei contenuti della Settimana 7 e correggi la bozza dei nuovi contenuti creati da altri.
Settimana 12 (29 novembre - 5 dicembre)
Ottimizza i contenuti scritti per garantire oggettività, accuratezza e coerenza. Documenterò e invierò anche le mie riflessioni sul successo del progetto e una valutazione dei miei mentor.