Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Il linguaggio Julia
- Technical Writer:
- sophb
- Nome del progetto:
- Reinventare il sito web di FluxML
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Questa proposta mira a migliorare il sito web della documentazione di Flux in modo che le informazioni in esso contenute siano strutturate e interessanti per principianti ed esperti. In particolare, l'obiettivo è riorganizzare la documentazione esistente in nuove sezioni e creare un nuovo tutorial introduttivo per i nuovi arrivati che estende il tutorial su Flux 60-mine-blitz.
Il progetto è costituito dalle seguenti fasi:
Analizza il sito web della documentazione attuale: controlla le informazioni esistenti e definisci una guida di stile (per le informazioni) per creare nuovi tutorial.
Definisci una nuova struttura per le informazioni e il tutorial introduttivo: collabora con i mentor per determinare le nuove sezioni e la riorganizzazione del sito web della documentazione. Inoltre, definisci un sommario per il tutorial introduttivo utilizzando come punto di partenza il tutorial su Flux 60-mine-blitz e utilizzalo.
Ristruttura le informazioni: aggiorna il sito web con il piano definito in collaborazione con i mentor nel passaggio precedente.
Crea il tutorial introduttivo: scrivi la prima bozza e rivedila. Ricevi un feedback dai mentor. Quando io e i mentori stabiliamo che abbiamo una versione finale di questo documento, lo pubblicherò sul sito web della documentazione.
(Facoltativo) Converti la documentazione esistente sotto forma di file README in HTML: se ho del tempo a disposizione dopo aver completato le quattro fasi principali, posso convertire i tutorial esistenti che sono file README in modo che sia più facile accedervi dal sito web.
Per raggiungere l'obiettivo del progetto, collaborerò molto strettamente con la community di Flux per comprendere la documentazione esistente e determinare l'approccio migliore. Anch'io sono un principiante di Julia e credo che questo sarà molto utile per determinare il livello giusto delle informazioni per il nuovo tutorial introduttivo.
Mi concentrerò sull'assicurarsi che il mio lavoro aiuti la community di Flux a integrare nuovi utilizzi. Inoltre, mi soffermerò su come aiutare gli utenti esperti a scoprire nuovi casi d'uso ed esplorare i dettagli più dettagliati di Flux.