本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Open3D
- 技術文件撰寫者：
- Rohan Rathi
- 專案名稱：
- Python 與 C++ API 技術說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
劇情大綱：
專案將分為 4 個部分： 升級及擴充 Open3D 貢獻者指南 完整 Python API 說明文件 完整 C++ API 說明文件 核心資料結構總覽文件
說明：
我在專案中將專案分為 4 個部分：
我打算為新手入門填寫及更新貢獻者指南，當中提供詳盡的逐步指南，說明如何建構原始碼、製作說明文件並加入開發人員社群。除了書面指南外，我還打算製作一部影片，實際展示如何建立 YouTube 頻道原始碼。我也會新增相關指南，說明新的開發人員如何使用 pybind 和 doxygen 變更 sphinx 建構的原始碼，藉此為說明文件提供貢獻。
擴充 Python API 說明文件。目前 Python API 包含類別和成員函式的基本文件字串，可提供對功能有偏誤的說明。我計劃改寫 Python API 說明文件，讓 API 更容易理解，功能也更加清楚。我還打算針對不同區域使用的相關 3D 圖形概念新增連結 (例如相機中使用的內建矩陣)
完成 C++ API 說明文件。與 Python 說明文件相比，C++ 說明文件中目前沒有對等的文件字串。我打算詳細說明類別及其相關聯的成員職能和資料成員。
核心資料結構的高層級與低階說明文件。我想瞭解各種資料結構 (例如 TriangleMesh、LineSet、Octree) 的程式碼，並在程式碼集中新增註解，以便開發新開發人員和任何使用者。也會透過改善教學課程，提供詳盡的結構說明文件，讓您瞭解結構涉及的使用方法與概念。我會提供詳細使用範例，並加入結構概念的相關連結。 只要時間允許，我就會處理比較簡單的工作，像是記錄如何執行某些工作，協助新進使用者與軟體的關係。
專案時間表
8 月 1 日 - 9 月 1 日：
熟悉我的導師，並進一步討論程式碼集不同部分所需的文件層級，並探討如何深入介紹低級別和高階的說明文件。我也會抽空瞭解程式碼集並研究相關概念，以便進一步記錄。
第 1 週和第 2 週：
我會更新並補充貢獻者指南。我會改善有關如何建構原始碼的說明文件。我也會在說明文件中新增文件人員部分，說明新貢獻者可提供哪些協助。我也會製作一部 YouTube 影片，逐步說明如何建構原始碼。
第 3 週 - 5 週：
我會努力擴充 Python API。重述現有說明文件，並撰寫現有成員的詳細說明文件。我們也會附上相關概念的連結，讓使用者熟悉相關概念。
第 6 至 8 週：
大部分程式庫目前的 C++ 文件不完整，因此我會在大部分時間填寫 C++ 文件
第 9 至 11 週：
在這段期間，我將研究核心資料結構。重新建構每個資料結構的教學課程、提供概要總覽，並記錄使用方式範例。
最終一週：
我會在 12 週的說明文件期間，利用最後一週準備最終工作報告。我也會利用這段時間檢視並敲定說明文件。