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:
- Il linguaggio Julia
- Redattore tecnico:
- Shuo Liu
- Nome del progetto:
- LightGraphs Docs 2.0 e tutorial di JuliaGraphs intuitivi
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
In questo progetto di lunga data, migliorerò il sito web e la documentazione dei moduli in JuliaGraphs. Nello specifico, il mio lavoro includerà, a titolo esemplificativo, i seguenti contenuti.
Documenti LightGraphs 2.0 - 10 settimane
- Panoramica: LightGraphs.jl è un pacchetto di grafici leggeri ottimizzato per Julia, che funge da nucleo dell'ecosistema JuliaGraphs. La prossima versione 2.0 di LightGraphs rappresenta una modifica fondamentale dell'API LightGraphs. Mi assicurerò che la documentazione rappresenti le funzionalità più recenti e straordinarie di Light Graph.
- Risultati: eseguirò un controllo della documentazione dell'API esistente per verificare quale documentazione può rimanere invariata e analizzerò le modifiche apportate nella release 2.0 per assicurarmi che siano adeguatamente documentate con esempi. Durante questo processo, scriverò post che mettono in evidenza le modifiche principali nella release 2.0. Per aiutare i neofiti a comprendere meglio LightGraphs, creerò guide per principianti per chi fa i primi passi nel mondo dell'utilizzo dei grafici in Julia.
- Note: in questo progetto, Documenter.jl verrà utilizzato come generatore di documenti per creare i documenti di LightGraphs. Oltre ai riferimenti all'API per moduli come Coloring.jl, ne ho bisogno anche per i sottomoduli come greedy_color.jl. Scopriremo come aggiungerli per rinnovare la documentazione di LightGraphs. Inoltre, la teoria dei grafici è un campo della matematica molto tecnico e oscuro per coloro che non hanno competenze matematiche. Mi occupo di ricerca accademica da circa 2 anni e ho scritto molti post del blog sul mio sito web personale, quindi posso spiegare l'essenza di diversi algoritmi e dare suggerimenti su quali utilizzare in varie situazioni durante la creazione delle guide per principianti.
Tutorial di JuliaGraphs - 10 settimane
- Panoramica: gran parte della documentazione dei pacchetti JuliaGraphs è rivolta agli sviluppatori. Aggiungerò alcuni semplici esempi e illustrerò l'utilizzo di ogni funzionalità, rendendola più accessibile agli utenti.
- Risultati: eseguirò un controllo dei tutorial di LightGraphs esistenti per vedere quali materiali devono essere aggiunti e dimostrare l'utilizzo e la motivazione di ogni funzionalità. Poi seguirò la modalità di JuliaGraphsTutorials per espandere i tutorial di JuliaGraphs, inclusa la guida per principianti nell'ecosistema LightGraphs.
- Note: al momento i contenuti di JuliaGraphsTutorials non sono sufficientemente approfonditi. Gli elementi sopra elencati sono principalmente per il pacchetto LightGraphs. Se il tempo lo consente, aggiungerò anche tutorial per altri moduli in JuliaGraphs, come GraphPlot.jl, MetaGraphs.jl e SimpleWeightedGraphs.jl.
Sito web JuliaGraphs Central - 4 settimane
- Panoramica: il sito web centrale di JuliaGraphs offre una panoramica dei pacchetti dell'ecosistema. Tuttavia, si tratta ancora principalmente di una descrizione e può essere ulteriormente migliorata per diventare la prima risorsa per chi inizia a utilizzare i grafici in Julia. Troverò un modo intuitivo con la visualizzazione per mettere in evidenza le funzionalità dei vari pacchetti JuliaGraphs.
- Risultati: fornirò casi d'uso ed esempi per mettere in evidenza le funzionalità dei pacchetti JuliaGraphs ed eseguiremo un controllo per assicurarci che siano ancora pertinenti e supportati. Creerò una sezione che metta in evidenza i diversi utilizzi dei vari pacchetti in diversi domini (sanità, istruzione e così via). Se il tempo a disposizione lo consente, cercherò le spiegazioni visive degli algoritmi utilizzati nei grafici.
- Note. Molti pacchetti di JuliaGraphs sono stati ampiamente utilizzati in domini diversi. Oltre alle estensioni di rappresentazione come DiGraph per NetworkViz, alcune altre applicazioni in materie specifiche che includerò sono MetaGraph per le biostrutture in biologia, DijkstraState per l'assegnazione del traffico nella pianificazione urbana, DiGraph per TreeView nell'istruzione e ecc..