本頁面包含 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 包含了類別和成員函式的基本 docstring，可提供功能的模糊描述。我打算重新撰寫 Python API 說明文件，讓 API 更容易理解，功能也更清楚。我還打算新增連結，連結至不同領域中使用的相關 3D 圖形概念 (例如：相機中使用的內在矩陣)
完成 C++ API 說明文件。目前，相較於 Python 說明文件，C++ 說明文件中沒有對等的 docstring。我打算詳細記錄類別及其相關成員函式和資料成員。
核心資料結構的高階和低階說明文件。我打算瞭解各種資料結構 (例如 TriangleMesh、LineSet、Octree) 的程式碼，並在程式碼集中加入註解，方便新開發人員和任何使用者瞭解。並透過改善教學課程，提供結構體相關用法和概念的概略說明文件。我會提供詳細使用範例，並提供結構相關概念的連結。 如果時間允許，我會著手處理較簡單的工作，例如記錄如何執行特定工作，以協助新使用者熟悉軟體。
專案時間表：
8 月 1 日至 9 月 1 日：
請和導師熟悉，進一步深入討論程式碼集各部分需要的說明文件，並深入探討低階與高階說明文件要如何取得的資料。我也會花時間瞭解程式碼集並研究各種概念，以便更妥善地記錄這些概念。
第 1 週和第 2 週：
我會更新並擴充貢獻者指南。我會改善說明文件，說明如何建構原始碼。我也會新增「文件編寫者」專區，說明新貢獻者如何協助編寫說明文件。我也會製作 YouTube 影片，逐步說明如何建構原始碼。
第 3 到第 5 週：
我會致力擴充 Python API。重新表達現有說明文件的內容，並詳細說明現有成員。我也會新增相關連結，讓使用者更瞭解相關概念。
第 6 到 8 週：
目前的 C++ 文件對程式庫的大部分內容並不完整，所以我會花大部分的時間填寫 C++ 文件
第 9 到 11 週：
在這段期間，我會著手處理核心資料結構。重新建構各個資料結構的教學課程，提供概略的總覽，並記錄使用方式的詳細範例。
最後一週：
我會在最後一週準備最終報告，說明在 12 週的文件撰寫期間完成的工作。我也會來閱讀及擬定說明文件。