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