หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Apache Flink
- นักเขียนเชิงเทคนิค
- haseeb1431
- ชื่อโปรเจ็กต์:
- ส่วนขยายของ Table API และเอกสารประกอบ SQL สําหรับ Apache Flink
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ฉันส่งใบสมัครเข้าร่วม GSOD เกี่ยวกับ "ขยาย Table API และเอกสารประกอบ SQL" เราจะเขียนเอกสารประกอบ API เพื่อให้คุณยายเขียนการค้นหาได้เช่นกัน แม้ว่าเราอาจมีโครงสร้างอยู่แล้ว แต่เราจะทำตามขั้นตอนนี้ในฐานะผู้ใช้มือใหม่และแนะนำแนวคิดเมื่อจำเป็น เราวางแผนที่จะทํางานร่วมกับที่ปรึกษาอย่างใกล้ชิดเพื่อทําความเข้าใจกระบวนการคิดของที่ปรึกษา พร้อมกับแชร์แนวคิดต่างๆ ตามประสบการณ์ในอุตสาหกรรมที่ผ่านมา
แนวคิดเบื้องต้นบางส่วนตามเอกสารประกอบปัจจุบันมีดังนี้
ปัจจุบันหน้าภาพรวมมีข้อมูลจำนวนมาก แต่ต้องได้รับการตรวจสอบและจัดเรียงใหม่เพื่อให้ทั้งผู้ใช้มือใหม่และผู้ใช้ขั้นสูงเริ่มต้นใช้งานได้อย่างรวดเร็ว แนวคิดของเราคือการเริ่มต้นใช้งานแทร็กต่างๆ ที่เป็นไปได้ ได้แก่ ก) การเริ่มโปรเจ็กต์ใหม่แล้วเรียกใช้การค้นหาในโปรเจ็กต์นั้น ข) การเรียกใช้การค้นหา SQL หรือ Table API ในโปรเจ็กต์ที่มีอยู่
นอกจากนี้ เรายังต้องมีแผนที่ฉบับสมบูรณ์ของเอกสาร API ในหน้า Landing Page เพื่อให้ผู้ใช้ดูความเป็นไปได้ทั้งหมดได้อย่างรวดเร็ว โดยจะเป็นเวอร์ชันปรับปรุงของส่วน "ควรทำสิ่งใดต่อไป" ในหน้าภาพรวมปัจจุบัน
หน้าแนวคิดมีเนื้อหาค่อนข้างดี แต่เต็มไปด้วยเนื้อหามากในหน้าเดียว เราจึงจะมีส่วนย่อย 2-3 ส่วนในหน้านี้ ในทํานองเดียวกัน ส่วนอื่นๆ เช่น เครื่องมือวางแผน ฟังก์ชันในตัว และเครื่องมือเชื่อมต่อ ก็ต้องแสดงให้ผู้ใช้เห็นมากขึ้น เช่น ในหน้าภาพรวมหรือแถบนําทางด้านซ้าย หน้าเครื่องมือเชื่อมต่อสามารถแบ่งออกเป็นส่วนย่อยเพิ่มเติมได้ เช่น เครื่องมือเชื่อมต่อ รูปแบบ และอื่นๆ ฟังก์ชันของระบบ (ในตัว) ดูดีแล้วสำหรับเรา เนื่องจากเรามีวิธีการทั้งหมดที่เป็นไปได้ในหน้าเดียว และผู้ใช้สามารถอ้างอิงฟังก์ชันเหล่านี้เป็นชีตสรุปได้ตลอดเวลา แต่เรายินดีที่จะเพิ่มเนื้อหาเพิ่มเติมเกี่ยวกับเรื่องนี้
ระยะเวลา 3 เดือนจะแบ่งออกเป็นช่วงต่างๆ ขั้นแรก เราจะสร้างโครงสร้างของเอกสารประกอบ Table และ SQL API เช่น Sitemap เราจะเปิดตัวส่วนย่อยและแนะนำเนื้อเรื่องตามที่ได้แชร์ไว้ข้างต้น เมื่อเสร็จแล้ว เราจะตรวจสอบกับผู้ใช้ระดับขั้นสูงและระดับเริ่มต้น ในทางกลับกัน เราอาจเริ่มเขียนเกี่ยวกับเครื่องมือวางแผนและเครื่องมือเชื่อมต่อระหว่างรอความคิดเห็น เมื่อได้รับความคิดเห็นแล้ว เราจะปรับโครงสร้างเอกสาร API ถัดไป เราจะจดจ่อกับการเขียนในส่วนที่รอดำเนินการให้เสร็จสิ้น สุดท้ายนี้ หากมีเวลา เราวางแผนที่จะยกตัวอย่างตั้งแต่ต้นจนจบและแสดงการใช้งานโปรเจ็กต์จากต้นทางถึงปลายทางซึ่งสามารถใช้ประโยชน์ได้สำหรับ FLINK-12639
เราขอเสนอให้จัดการประชุมเป็นเวลา 1 ชั่วโมงหลังจากผ่านไป 2 สัปดาห์ นอกเหนือจากการแชทใน Slack (หรือเครื่องมืออื่นๆ) เราจะแชร์ไทม์ไลน์เริ่มต้นของโปรเจ็กต์พร้อมสัปดาห์ที่คาดว่าจะเสร็จ ซึ่งจะช่วยให้เราติดตามความคืบหน้าของโปรเจ็กต์ได้แบบรายสัปดาห์ด้วย
สุดท้าย เอกสารประกอบนี้คล้ายกับบล็อกของเราใน medium.com ซึ่งเราเพิ่มรายละเอียดพื้นฐานทั้งหมดเมื่อเรียนรู้ฟังก์ชันการทํางานต่างๆ ของ Flink API นอกจากนี้ ประสบการณ์นี้ยังทำให้ฉันเป็นตัวเลือกที่ไม่เหมือนใคร เนื่องจากฉันจะยืนยันเอกสารประกอบด้วยการติดตั้งใช้งานจริง ไม่ใช่แค่เขียนเอกสารทางเทคนิค โปรเจ็กต์นี้จะทํางานแบบ 2 ทางสําหรับฉัน เนื่องจากฉันจะมีส่วนร่วมในเอกสารประกอบโอเพนซอร์สไปพร้อมกับเรียนรู้ Table และ SQL API