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