Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Data Commons
- Penulis teknis:
- KilimAnnejaro
- Nama proyek:
- Memperbaiki Dokumentasi Memulai DataCommon
- Durasi project:
- Durasi standar (3 bulan)
Project description
Dalam karier saya sebagai engineer software, saya sering kali merasa frustrasi dengan pengalaman bergabung dengan tim atau project baru, mengambil repositori kode, menjalankannya, dan melihat software rusak saat langkah-langkah utama tidak ada dalam dokumentasi. Saya segera menyadari bahwa saya dapat menerapkan minat saya selama ini dalam menulis dan komposisi untuk memenuhi kebutuhan ini, dalam prosesnya menciptakan lingkungan yang mendukung bagi developer yang bekerja sama dengan saya untuk berfokus pada inovasi dan kreativitas teknis, bukan menyelesaikan masalah dengan jawaban yang sudah diketahui.
Inovasi dan kreativitas teknis ini sangat diperlukan di banyak segmen masyarakat, terutama oleh para pemimpin di pemerintahan dan sektor lembaga nonprofit yang ingin menganalisis set data di ruang masalah mereka. Dengan menyediakan data ini sebagai layanan, DataCommons menurunkan hambatan masuk bagi analis yang mencari data yang mudah diakses dan mendekati format yang mereka butuhkan untuk peran mereka. DataCommons melakukannya dengan membuat Knowledge Graph dari data yang ditransfernya, yang dalam prosesnya menimbulkan pertanyaan menarik tentang kualitas dan tata kelola data dalam konteks open source. Dengan mendaftar ke Google Summer of Docs beserta proposal untuk organisasi DataCommons, saya berharap dapat mendukung dan memajukan upaya teknis ini untuk kepentingan publik mengenai ruang data terbuka.
Poin Masalah 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 project ini, saya mengusulkan untuk membersihkan bagian 'Get Involved' di dataCommons.org. Saya akan membuat tutorial untuk menambahkan set data baru, yang menjelaskan cara set data di-scrap dan digabungkan ke dalam grafik pengetahuan dataCommons. Saya juga akan menambahkan bagian FAQ untuk solusi umum yang disarankan saat pemilik set data 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 project ini, saya akan menerjemahkan notebook ini ke R dan juga membuat versi demo interaktif dari contoh saat ini untuk Google Spreadsheet dan REST API, dengan menyematkan demo ini ke dalam dokumentasi saat ini.
Terakhir, dokumentasi tidak benar-benar menawarkan contoh cara grafik pengetahuan dataCommons dapat digunakan untuk mem-build aplikasi dalam software. Sebagai bagian dari project ini, saya akan membuat, men-deploy, dan mendokumentasikan contoh alat di Python yang menggunakan dataCommons API untuk memungkinkan pengguna akhir membuat visualisasi grafis yang menghubungkan dua kuantitas yang terhubung dalam grafik pengetahuan. Misalnya, seseorang mungkin dapat menggunakan alat ini untuk menggambar regresi linear yang mengaitkan data cuaca dengan informasi pola bisnis umum. Sebagai tujuan tambahan, saya berharap dapat memperluas alat ini ke jenis visualisasi lainnya, seperti bagan pai dan diagram Venn.
Jadwal Musim ini berlangsung dari 14 September hingga 30 November, jadi rencana saya untuk menyelesaikan project ini terlihat seperti ini:
September: Mulai dengan menulis ulang bagian Ikut Serta; selesaikan sebagian besar pekerjaan ini pada akhir September.
Oktober: Menyelesaikan bagian Ikut Serta dan membuat contoh kode interaktif.
November: Membuat alat visualisasi contoh.