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:
- Data Commons
- Technical Writer:
- KilimAnnejaro
- Nome del progetto:
- Miglioramento della documentazione introduttiva di DataCommons
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Nella mia carriera di software engineer, mi sono sentita più volte frustrata dall'esperienza di entrare in un nuovo team o progetto, recuperare un repository di codice, eseguirlo e osservare l'interruzione del software quando mancavano i passaggi chiave nella documentazione. Ho capito subito che potevo applicare la mia passione per la scrittura e la composizione a queste esigenze, creando al contempo un ambiente di supporto per gli sviluppatori con cui collaboravo, in modo che potessero concentrarsi sull'innovazione tecnica e sulla creatività, anziché risolvere problemi con risposte note.
Questa creatività e innovazione tecnica sono urgentemente necessarie in molti segmenti della società, in particolare dai leader del governo e del settore non profit che cercano di analizzare i set di dati nei loro spazi di problemi. Rendendo questi dati immediatamente disponibili come servizio, DataCommons abbassa la soglia di ingresso per gli analisti che cercano dati di facile accesso e vicini al formato di cui hanno bisogno per i loro ruoli. DataCommons lo fa creando un Knowledge Graph dei dati che importa, sollevando nel contempo interessanti domande sulla qualità e sulla governance dei dati nel contesto dell'open source. Presentando domanda di partecipazione a Google Summer of Docs con una proposta per l'organizzazione DataCommons, spero di supportare e promuovere questi sforzi tecnici nello spazio dei dati aperti di interesse pubblico.
Problemi attuali nella documentazione con soluzioni proposte Sebbene il sito web di dataCommons contenga indicazioni per l'aggiunta di set di dati a dataCommons, queste sono molto brevi e poco chiare, costituite da diversi elenchi puntati che invitano il potenziale donatore di dati a utilizzare 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 vengono estratti e incorporati nel Knowledge Graph di dataCommons. Aggiungerò anche una sezione di domande frequenti per le soluzioni comuni suggerite quando un proprietario di set di dati contatta i manutentori di dataCommons per ricevere assistenza.
Se esaminiamo l'attuale insieme di esempi per eseguire query sui dati, dataCommons offre solo quattro esempi di codice interattivo, tutti notebook Python. Nell'ambito di questo progetto, tradurrò questi notebook in R e creerò anche versioni demo interattive degli esempi attuali per Fogli Google e l'API REST, incorporando queste demo nella documentazione attuale.
Infine, la documentazione non offre esempi di come il Knowledge Graph di dataCommons possa essere utilizzato per creare applicazioni in 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, potresti utilizzare questo strumento per eseguire una regressione lineare che metta in relazione i dati meteo con le informazioni sui modelli di attività comuni. Come obiettivo ambizioso, spero di estendere questo strumento ad altri tipi di visualizzazioni, come i grafici a torta e i diagrammi di Venn.
Programma La stagione va dal 14 settembre al 30 novembre, quindi il mio piano per completare questo progetto è il seguente:
Settembre: inizia a riscrivere la sezione Partecipa; completa il lavoro entro la fine di settembre.
Ottobre: ricapitola la sezione Come partecipare e crea gli esempi di codice interattivi.
Novembre: crea lo strumento di visualizzazione di esempio.