Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- La lingua giulia
- Technical writer:
- sophb
- Nome progetto:
- Reinventare il sito web di FluxML
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Questa proposta ha lo scopo di migliorare il sito web con la documentazione di Flux, in modo che le informazioni in esso contenute siano strutturate e attraenti per i nuovi arrivati e gli esperti. In particolare, l'obiettivo è riorganizzare la documentazione esistente in nuove sezioni e creare un nuovo tutorial introduttivo per i nuovi utenti che estenda il tutorial di Flux 60-mine-blitz.
Il progetto è costituito dalle seguenti fasi:
Analizza l'attuale sito web con la documentazione: verifica le informazioni esistenti e definisci una guida di stile (per informazioni) per la creazione di nuovi tutorial.
Definisci una nuova struttura per le informazioni e il tutorial introduttivo: collabora con i mentori per determinare le nuove sezioni e la riorganizzazione del sito web della documentazione. Inoltre, definisci un sommario per il tutorial introduttivo utilizzando il tutorial di Flux 60-mine-blitz come punto di partenza e continua a seguirlo.
Ristruttura le informazioni: aggiorna il sito web con il piano definito in collaborazione con i mentori nel passaggio precedente.
Crea il tutorial introduttivo: scrivi la prima bozza e rivedila. Ricevere feedback dai mentori. Quando io e i mentori stabiliamo che abbiamo una versione finale di questo documento, la pubblicherò sul sito web della documentazione.
(Facoltativo) Converti la documentazione esistente in formato README in HTML: se ho ancora un po' di tempo dopo aver completato le quattro fasi principali, posso convertire i tutorial esistenti che sono file README in modo da poter accedere più facilmente dal sito web.
Per raggiungere l'obiettivo del progetto, lavorerò a stretto contatto con la community di Flux per comprendere la documentazione esistente e determinare l'approccio migliore. Sono io che ho appena iniziato a lavorare per Julia e ritengo che questa guida ti sarà molto utile per determinare il giusto livello di informazioni per il nuovo tutorial introduttivo.
Mi occuperò di assicurarmi che il mio lavoro aiuti la community di Flux a gestire nuovi utilizzi. Inoltre, mi dedicherò ad aiutare gli utenti esperti a scoprire nuovi casi d'uso ed esplorare i dettagli di Flux.