Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Data Commons
- Technical writer:
- KilimAnnejaro
- Nome progetto:
- Documentazione introduttiva sull'ottimizzazione di DataCommons
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Nella mia carriera di ingegnere del software, mi sono sentita più volte frustrata dall'idea di entrare a far parte di un nuovo team o di un nuovo progetto, di abbattere un repository di codice, di eseguirlo e di assistere all'interruzione del software quando mancavano passaggi chiave nella documentazione. Mi sono subito reso conto che potevo applicare la mia passione di una vita per la scrittura e la composizione a queste esigenze, creando un ambiente favorevole per gli sviluppatori con cui ho lavorato per concentrarsi sull'innovazione tecnica e sulla creatività, piuttosto che risolvere problemi con risposte note.
Questa innovazione tecnica e creatività sono imprescindibili in molti segmenti della società, in particolare per i leader di governo e del settore non profit che cercano di analizzare set di dati nei loro spazi problematici. Rendendo questi dati immediatamente disponibili as a Service, DataCommons riduce la barriera all'accesso per gli analisti alla ricerca di dati facilmente accessibili e vicini al formato di cui hanno bisogno per i loro ruoli. A questo scopo, DataCommons crea un Knowledge Graph dei dati che importa, sollevando nel frattempo domande interessanti sulla qualità e sulla governance dei dati nel contesto dell'open source. Presentando la domanda per Google Summer of Docs con una proposta per l'organizzazione DataCommons, spero di supportare e far progredire queste iniziative tecniche nell'ambito dei dati aperti di interesse pubblico.
Punti critici attuali nella documentazione relativa alle soluzioni proposte Sebbene il sito web dataCommons contenga istruzioni per l'aggiunta di set di dati a dataCommons, le indicazioni sono molto brevi e poco chiare e sono composte da diversi elenchi puntati che indirizzano l'aspirante donatore di dati a usare il markup schema.org. Nell'ambito di questo progetto, propongo di ripulire la sezione "Partecipa" di dataCommons.org. Creerò un tutorial per l'aggiunta di nuovi set di dati, spiegando come i set di dati vengono copiati e incorporati nel Knowledge Graph dataCommons. Aggiungerò anche una sezione di domande frequenti per le soluzioni comuni suggerite quando il proprietario di un set di dati contatterà i manutentori di dataCommons per ricevere assistenza.
Guardando l'attuale set di esempi per l'esecuzione di query sui dati, dataCommons offre solo quattro esempi di codice interattivi, tutti blocchi note Python. Nell'ambito di questo progetto, tradurrò questi blocchi note in R e creerò versioni demo interattive degli esempi presenti per Fogli Google e l'API REST, incorporando queste demo nella documentazione attuale.
Infine, la documentazione in realtà non offre alcun esempio di come il Knowledge Graph dataCommons possa essere utilizzato per creare applicazioni nel software. Nell'ambito di questo progetto, creerò, eseguirò il deployment e documenterò uno strumento di esempio in Python che utilizza l'API dataCommons per consentire all'utente finale di creare visualizzazioni grafiche relative a due quantità collegate all'interno del Knowledge Graph. Ad esempio, si potrebbe essere in grado di utilizzare questo strumento per tracciare una regressione lineare in relazione ai dati meteo relativi a informazioni sui modelli aziendali comuni. Come obiettivo principale, spero di estendere questo strumento ad altri tipi di visualizzazioni, come i grafici a torta e i diagrammi di Venn.
Pianificazione La stagione va dal 14 settembre al 30 novembre, quindi il mio piano per il completamento di questo progetto sarebbe il seguente:
Settembre: inizia a riscrivere la sezione Partecipa al programma; completa questo lavoro per la maggior parte entro la fine di settembre.
Ottobre: riassumi la sezione Partecipa e crea esempi di codice interattivi.
Novembre: crea lo strumento di visualizzazione di esempio.