Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Data Commons
- Penulis teknis:
- KilimAnnejaro
- Nama proyek:
- Menyempurnakan Dokumentasi Memulai DataCommons
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Dalam karier sebagai {i>software engineer<i}, saya berulang kali frustrasi dengan pengalaman bergabung dengan tim atau proyek baru, menarik repositori kode, menjalankannya, dan menyaksikan kerusakan perangkat lunak ketika ada langkah-langkah penting yang hilang dari dokumentasi. Saya segera menyadari bahwa saya dapat menerapkan minat menulis dan komposisi seumur hidup saya pada kebutuhan ini, dalam proses menciptakan lingkungan yang suportif bagi developer yang bekerja dengan saya untuk berfokus pada inovasi teknis dan kreativitas, daripada memecahkan masalah dengan jawaban yang diketahui.
Inovasi teknis dan kreativitas ini sangat dibutuhkan di banyak segmen masyarakat, terutama oleh para pemimpin di sektor pemerintahan dan sektor nonprofit yang ingin menganalisis set data di ruang masalah mereka. Dengan membuat data ini tersedia sebagai layanan, DataCommons menurunkan hambatan masuk bagi analis yang mencari data yang mudah diakses dan dekat dengan format yang mereka butuhkan untuk peran mereka. DataCommons melakukannya dengan membuat Pustaka Pengetahuan dari data yang diserapnya, dalam prosesnya yang mengajukan pertanyaan menarik tentang kualitas data dan tata kelola dalam konteks open source. Dengan mendaftar ke Google Summer of Docs melalui proposal untuk organisasi DataCommons, saya berharap dapat mendukung dan memajukan upaya teknis ini di ruang data terbuka kepentingan publik.
Poin Kendala Saat Ini dalam Dokumentasi dengan Solusi yang Diusulkan Meskipun situs dataCommons berisi petunjuk untuk menambahkan set data ke dataCommons, petunjuknya sangat singkat dan tidak jelas, yang terdiri dari beberapa poin yang mengarahkan calon donatur data untuk menggunakan markup schema.org. Sebagai bagian dari proyek ini, saya mengusulkan untuk membersihkan bagian 'Ikut Terlibat' di dataCommons.org. Saya akan membuat tutorial untuk menambahkan {i>dataset<i} baru, menjelaskan bagaimana {i>dataset<i} disalin dan dimasukkan ke dalam pustaka pengetahuan dataCommons. Saya juga akan menambahkan bagian FAQ untuk solusi umum yang disarankan ketika pemilik {i>dataset<i} menghubungi pengelola dataCommons untuk mendapatkan bantuan.
Melihat kumpulan contoh saat ini untuk membuat kueri data, dataCommons hanya menawarkan empat contoh kode interaktif, semuanya adalah notebook Python. Sebagai bagian dari proyek ini, saya akan menerjemahkan notebook ini ke dalam R dan juga membuat versi demo interaktif dari contoh yang disajikan untuk Google Sheets dan REST API, dengan menyematkan demo ini ke dalam dokumentasi terbaru.
Akhirnya, dokumentasi tidak benar-benar menawarkan contoh bagaimana pustaka pengetahuan dataCommons dapat digunakan untuk membangun aplikasi dalam perangkat lunak. Sebagai bagian dari proyek ini, saya akan membuat, men-deploy, dan mendokumentasikan alat contoh di Python yang menggunakan dataCommons API untuk memungkinkan pengguna akhir membuat visualisasi grafis yang berkaitan dengan dua kuantitas yang terhubung dalam pustaka pengetahuan. Misalnya, seseorang mungkin dapat menggunakan alat ini untuk menggambar regresi linier yang berkaitan dengan data cuaca dengan informasi pola bisnis umum. Sebagai tujuan tambahan, saya berharap untuk memperluas alat ini ke jenis visualisasi lain, seperti bagan pai dan diagram Venn.
Jadwal Musim ini berlangsung dari 14 September-30 November, jadi rencana saya untuk menyelesaikan proyek ini terlihat seperti ini:
September: Mulailah dengan menulis ulang bagian Get Involved; biasanya selesaikan pekerjaan ini pada akhir September.
Oktober: Akhiri bagian Get Involved dan buat contoh kode interaktif.
November: Buat contoh alat visualisasi.