หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- Open3D
- ผู้เขียนด้านเทคนิค:
- โรฮันราธี
- ชื่อโปรเจ็กต์:
- เอกสารทางเทคนิคของ Python และ C++ API
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
เรื่องย่อ:
โปรเจ็กต์จะแบ่งออกเป็น 4 ส่วนดังนี้ อัปเกรดและขยายคู่มือสำหรับผู้จัดทำ Open3D จัดทำเอกสาร Python API ฉบับเต็ม เอกสารประกอบเกี่ยวกับ C++ API ฉบับเต็ม เอกสารระดับสูงเกี่ยวกับโครงสร้างข้อมูลหลัก
คำอธิบาย:
ในโปรเจ็กต์ของฉัน ฉันวางแผนที่จะแบ่งโปรเจ็กต์ออกเป็น 4 ส่วน ดังนี้
ฉันวางแผนที่จะดำเนินการและอัปเดตคู่มือสำหรับผู้ร่วมให้ข้อมูลสำหรับมือใหม่ที่ให้คำแนะนำแบบทีละขั้นตอนที่ครอบคลุมเกี่ยวกับวิธีการสร้างซอร์สโค้ด จัดทำเอกสารประกอบ และเข้าร่วมชุมชนนักพัฒนาซอฟต์แวร์ นอกเหนือจากคำแนะนำที่เป็นลายลักษณ์อักษรแล้ว ผมตั้งใจจะทำวิดีโอแสดงขั้นตอนที่แน่นอนในการสร้างซอร์สโค้ดสำหรับช่อง YouTube นอกจากนี้ ฉันจะเพิ่มคำแนะนำว่านักพัฒนาซอฟต์แวร์รายใหม่สามารถมีส่วนร่วมในเอกสารประกอบโดยการเปลี่ยนแปลงซอร์สโค้ดที่สร้างโดย sphinx โดยใช้ pybind และ doxygen ได้อย่างไร
ขยายเอกสารประกอบเกี่ยวกับ Python API ปัจจุบัน Python API มี docstring พื้นฐานสำหรับคลาสและฟังก์ชันสมาชิกที่ให้คำอธิบายฟังก์ชันการทำงานที่ไม่ชัดเจน ฉันวางแผนที่จะปรับเปลี่ยนเอกสารเกี่ยวกับ 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 สัปดาห์ นอกจากนี้เราจะใช้เวลาในการตรวจสอบและสรุปเอกสารให้เสร็จสิ้น