หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- ข้อมูลทั่วไป
- ผู้เขียนด้านเทคนิค:
- KilimAnnejaro
- ชื่อโปรเจ็กต์:
- การปรับปรุงเอกสารประกอบการเริ่มต้นใช้งาน DataCommons
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ในอาชีพของฉันในฐานะวิศวกรซอฟต์แวร์ ฉันรู้สึกหงุดหงิดกับประสบการณ์การเข้าร่วมทีมหรือโปรเจ็กต์ใหม่ การดึงที่เก็บโค้ด การเรียกใช้ และการดูช่วงพักเมื่อขาดขั้นตอนสำคัญในเอกสาร ฉันรู้ไม่นานว่าฉันสามารถนำความหลงใหลในการเขียนและการเรียบเรียงไปปรับใช้ตามความต้องการเหล่านี้ได้ ในกระบวนการสร้างสภาพแวดล้อมที่สนับสนุนนักพัฒนาแอปที่ฉันทำงานด้วย เพื่อมุ่งเน้นนวัตกรรมและความคิดสร้างสรรค์ทางเทคนิคมากกว่าการแก้ปัญหาด้วยคำตอบที่รู้อยู่แล้ว
นวัตกรรมและความคิดสร้างสรรค์เชิงเทคนิคนี้เป็นสิ่งจำเป็นเร่งด่วนในหลากหลายกลุ่มของสังคม โดยเฉพาะอย่างยิ่งผู้นำในภาคส่วนภาครัฐและองค์กรการกุศลที่กำลังมองหาวิธีวิเคราะห์ชุดข้อมูลในพื้นที่ที่เป็นปัญหา เมื่อทำให้ข้อมูลนี้พร้อมใช้งานในรูปแบบบริการ DataCommons จึงลดอุปสรรคในการเข้าถึงนักวิเคราะห์ที่กำลังมองหาข้อมูลที่เข้าถึงง่ายและใกล้เคียงกับรูปแบบที่ต้องการสำหรับบทบาทของตน DataCommons ทำเช่นนี้โดยสร้างกราฟความรู้ของข้อมูลที่นำเข้ามาในกระบวนการสร้างคำถามที่น่าสนใจเกี่ยวกับคุณภาพและการกำกับดูแลข้อมูลในบริบทของโอเพนซอร์ส การสมัครเข้าร่วม Google Summer of Docs พร้อมกับข้อเสนอขององค์กร DataCommons ทำให้ฉันหวังว่าจะได้สนับสนุนและผลักดันความพยายามด้านเทคนิคเหล่านี้ในพื้นที่เก็บข้อมูลสาธารณะประโยชน์
ประเด็นปัญหาปัจจุบันในเอกสารประกอบเกี่ยวกับโซลูชันที่เสนอ แม้ว่าเว็บไซต์ dataCommons จะมีคำแนะนำในการเพิ่มชุดข้อมูลลงใน dataCommons แต่เส้นทางนั้นสั้นและไม่ชัดเจน ประกอบด้วยจุดหัวข้อมากมายที่แจ้งให้ผู้บริจาคข้อมูลใช้มาร์กอัป schema.org ในฐานะส่วนหนึ่งของโครงการนี้ เราขอเสนอให้ล้างส่วน ‘Get Involved’ ของ dataCommons.org ฉันจะสร้างบทแนะนำสำหรับการเพิ่มชุดข้อมูลใหม่ เพื่ออธิบายว่าชุดข้อมูลถูกคัดลอกมาและรวมไว้ในกราฟความรู้ของ dataCommons อย่างไร นอกจากนี้ ฉันจะเพิ่มส่วนคำถามที่พบบ่อยสำหรับวิธีแก้ปัญหาทั่วไปที่แนะนำเมื่อเจ้าของชุดข้อมูลติดต่อผู้ดูแลของ dataCommons เพื่อขอความช่วยเหลือ
เมื่อพิจารณาชุดตัวอย่างปัจจุบันสำหรับการค้นหาข้อมูลแล้ว dataCommons มีตัวอย่างโค้ดแบบอินเทอร์แอกทีฟเพียง 4 ตัวอย่างเท่านั้น โดยทั้งหมดเป็นสมุดบันทึก Python ในโครงการนี้ เราจะแปลงสมุดบันทึกเหล่านี้เป็น R และสร้างเวอร์ชันสาธิตแบบอินเทอร์แอกทีฟของตัวอย่างที่นำเสนอสำหรับ Google ชีตและ REST API โดยฝังการสาธิตเหล่านี้ไว้ในเอกสารประกอบปัจจุบัน
สุดท้ายนี้ เอกสารประกอบก็ไม่มีตัวอย่างของวิธีใช้กราฟความรู้ของ dataCommons ในการสร้างแอปพลิเคชันในซอฟต์แวร์ ในฐานะส่วนหนึ่งของโครงการนี้ เราจะสร้าง ทำให้ใช้งานได้ และบันทึกเครื่องมือตัวอย่างใน Python ที่ใช้ dataCommons API เพื่อให้ผู้ใช้ปลายทางสร้างภาพกราฟิกที่เกี่ยวข้องกับปริมาณ 2 อย่างที่เชื่อมต่อกันภายในกราฟความรู้ได้ เช่น คนหนึ่งอาจใช้เครื่องมือนี้วาดข้อมูลสภาพอากาศที่ถดถอยเชิงเส้นไปยังข้อมูลรูปแบบธุรกิจทั่วไปได้ เป้าหมายที่กว้างขึ้น เราหวังที่จะขยายเครื่องมือนี้ไปยังการแสดงภาพประเภทอื่นๆ เช่น แผนภูมิวงกลมและแผนภาพเวนน์
กำหนดการ ฤดูกาลมีขึ้นตั้งแต่วันที่ 14 กันยายน - 30 พฤศจิกายน ดังนั้นแผนของฉันสำหรับการทำโปรเจกต์ให้เสร็จจึงมีลักษณะดังต่อไปนี้
กันยายน: เริ่มต้นจากการเขียนส่วน "มีส่วนร่วม" ใหม่ ซึ่งส่วนใหญ่จะเขียนให้เสร็จภายในสิ้นเดือนกันยายน
ตุลาคม: สรุปส่วน "มีส่วนร่วม" และสร้างตัวอย่างโค้ดแบบอินเทอร์แอกทีฟ
พฤศจิกายน: สร้างเครื่องมือแสดงข้อมูลเป็นภาพตัวอย่าง