หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- Open3D
- ผู้เขียนด้านเทคนิค:
- โรฮันราธี
- ชื่อโปรเจ็กต์:
- เอกสารทางเทคนิคของ Python และ C++ API
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
เรื่องย่อ:
โปรเจ็กต์จะแบ่งออกเป็น 4 ส่วน ดังนี้ การอัปเกรดและขยายคู่มือสำหรับผู้ร่วมให้ข้อมูล Open3D ดูเอกสารประกอบเกี่ยวกับ Python API ให้เสร็จสมบูรณ์ ดูเอกสารประกอบเกี่ยวกับ C++ API ให้เสร็จสมบูรณ์ เอกสารระดับสูงของโครงสร้างข้อมูลหลัก
คำอธิบาย:
ในโครงงานของฉัน ฉันวางแผนที่จะแบ่งโปรเจ็กต์ออกเป็น 4 ส่วนคือ
ฉันวางแผนที่จะดำเนินการและอัปเดตคู่มือสำหรับผู้ร่วมให้ข้อมูลสำหรับมือใหม่ ซึ่งให้คำแนะนำทีละขั้นตอนที่ครอบคลุมเกี่ยวกับวิธีสร้างซอร์สโค้ด จัดทำเอกสารประกอบ และเข้าร่วมชุมชนนักพัฒนาซอฟต์แวร์ นอกเหนือจากคู่มือที่เขียนเป็นลายลักษณ์อักษรแล้ว ฉันตั้งใจที่จะทำวิดีโอแสดงขั้นตอนในการสร้างซอร์สโค้ดสำหรับช่อง YouTube นอกจากนี้ ฉันจะเพิ่มคำแนะนำว่านักพัฒนาซอฟต์แวร์รายใหม่สามารถร่วมให้ข้อมูลกับเอกสารได้อย่างไรโดยการเปลี่ยนแปลงซอร์สโค้ดที่สร้างโดย sphinx โดยใช้pybind และ doxygen
ขยายเอกสารประกอบเกี่ยวกับ Python API ปัจจุบัน Python API มีสตริงเอกสารพื้นฐานสำหรับคลาสและฟังก์ชันสมาชิกที่ให้คำอธิบายที่คลุมเครือเกี่ยวกับฟังก์ชันการทำงาน ฉันวางแผนที่จะปรับเปลี่ยนเอกสาร Python API ซึ่งทำให้เข้าใจ API ได้ง่ายขึ้นและมีฟังก์ชันการทำงานที่ชัดเจนขึ้น ฉันยังต้องการเพิ่มลิงก์ไปยังแนวคิดเกี่ยวกับกราฟิก 3 มิติที่เกี่ยวข้องซึ่งใช้ในพื้นที่ต่างๆ (เช่น เมตริกภายในที่ใช้ในกล้อง)
ส่งเอกสารสำหรับ C++ API ให้ครบถ้วน ขณะนี้ไม่มีสตริงเอกสารที่เทียบเท่าในเอกสาร C++ เมื่อเทียบกับเอกสาร Python ฉันตั้งใจที่จะบันทึกรายละเอียดเกี่ยวกับชั้นเรียน และฟังก์ชันสมาชิกที่เกี่ยวข้อง และสมาชิกข้อมูล
เอกสารในระดับสูงและต่ำของโครงสร้างข้อมูลหลัก ฉันตั้งใจจะทำความเข้าใจโค้ดของโครงสร้างข้อมูลต่างๆ เช่น TriangleMesh, LineSet, Octree และเพิ่มความคิดเห็นในฐานของโค้ด ทั้งสำหรับความเข้าใจของนักพัฒนาแอปและผู้ใช้รายใหม่ รวมถึงจัดทำเอกสารระดับสูงเกี่ยวกับการใช้งานและแนวคิดที่เกี่ยวข้องในโครงสร้างโดยการปรับปรุงบทแนะนำ ฉันจะให้ตัวอย่างโดยละเอียดของการใช้งานและเพิ่มลิงก์ที่เกี่ยวข้องไปยังแนวคิดที่เกี่ยวข้องกับโครงสร้าง หากมีเวลาพอ ฉันจะทำงานง่ายๆ เช่น บันทึกวิธีทำงานบางอย่างที่สามารถช่วยให้ผู้ใช้รายใหม่ได้เชื่อมโยงกับซอฟต์แวร์
กำหนดการของโปรเจ็กต์
1 สิงหาคม - 1 กันยายน:
ทำความคุ้นเคยกับที่ปรึกษาและพูดคุยรายละเอียดเพิ่มเติมเกี่ยวกับเอกสารที่ต้องใช้ในส่วนต่างๆ ของฐานของโค้ด และพูดคุยถึงวิธีการเจาะลึกในเอกสารระดับต่ำเทียบกับระดับสูง นอกจากนี้ ฉันจะใช้เวลาทำความเข้าใจฐานของโค้ดและศึกษาแนวคิดเพื่อจัดทำเอกสารให้ดียิ่งขึ้น
สัปดาห์ที่ 1 และ 2
เราจะปรับปรุงและขยายคู่มือสำหรับผู้ให้ข้อมูลร่วมกัน เราจะปรับปรุงเอกสารประกอบเกี่ยวกับวิธีสร้างซอร์สโค้ด ฉันจะเพิ่มส่วนผู้จัดทำเอกสารเกี่ยวกับวิธีที่ผู้ร่วมให้ข้อมูลรายใหม่จะช่วยเหลือในเอกสารต่างๆ ด้วย ฉันจะจัดทำวิดีโอ YouTube พร้อมระบุวิธีสร้างซอร์สโค้ดแบบทีละขั้นตอนด้วย
สัปดาห์ที่ 3-5:
ฉันจะพยายามขยายการใช้งาน Python API ปรับเปลี่ยนเอกสารประกอบที่มีอยู่และเขียนลงในเอกสารประกอบโดยละเอียดของสมาชิกที่มีอยู่ นอกจากนี้ ฉันจะเพิ่มลิงก์ที่เกี่ยวข้องไปยังแนวคิดที่เกี่ยวข้อง เพื่อให้ผู้ใช้สามารถทำความคุ้นเคยกับแนวคิดที่เกี่ยวข้องได้
สัปดาห์ที่ 6-8:
เอกสาร C++ ปัจจุบันไม่สมบูรณ์สำหรับส่วนต่างๆ ของไลบรารี ฉันจึงมักจะใช้เวลาส่วนใหญ่ไปกับการป้อนข้อมูลในเอกสาร C++
สัปดาห์ที่ 9-11:
ในช่วงเวลานี้ ผมจะสร้างโครงสร้างข้อมูลหลัก ปรับโครงสร้างบทแนะนำสำหรับโครงสร้างข้อมูลแต่ละแบบ แสดงภาพรวมระดับสูง รวมไปถึงเอกสารรายละเอียดการใช้งานตัวอย่าง
สัปดาห์สุดท้าย:
ฉันจะใช้เวลาในสัปดาห์สุดท้ายในการเตรียมรายงานฉบับสุดท้ายเกี่ยวกับงานที่ทำเสร็จในระหว่างระยะเวลาการยื่นเอกสารประกอบ 12 สัปดาห์ของฉัน นอกจากนี้ เราจะใช้เวลาทบทวนและสรุปเอกสารให้เสร็จสิ้นด้วย