本页详细介绍了 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++ 文档目前没有等效的 docstring。我打算详细记录类及其关联的成员函数和数据成员。
核心数据结构的高级和低级文档。我打算了解 TriangleMesh、LineSet、Octree 等各种数据结构的代码，并在代码库中添加注释，以便新开发者和任何用户了解。并通过改进教程，提供有关这些结构的使用和相关概念的概要文档。我会详细提供使用示例，并添加指向结构中涉及的概念的相关链接。 如果时间允许，我会着手处理更简单的任务，例如记录如何执行某些任务，以帮助新用户与该软件建立关联。
项目时间表-
8 月 1 日至 9 月 1 日：
与我的导师熟悉起来，并更深入地讨论代码库不同部分所需的文档级别，以及如何在低级文档和高级文档中进行深入探讨。我还会利用这段时间了解代码库并研究相关概念，以便更好地记录这些内容。
第 1 周和第 2 周：
我会更新和扩展贡献者指南。我会改进有关如何构建源代码的文档。此外，我还将添加文档编制部分，介绍新贡献者如何协助编写文档。我还会制作一个 YouTube 视频，详细说明如何构建源代码。
第 3 - 5 周：
我将致力于扩展 Python API。改写现有文档，并详细说明现有成员。此外，我还会添加指向相关概念的相关链接，以便用户更好地了解所涉及的概念。
第 6-8 周：
目前，C++ 文档中大部分库的部分未完成，因此我将把大部分时间花在填充 C++ 文档上
第 9-11 周：
在此期间，我将致力于核心数据结构。重构了每个数据结构的教程，提供了概要介绍，并记录了示例用法详情。
最后一周：
我将利用最后一周，针对在 12 周的记录期内所完成的工作，准备最终报告。我还会利用这段时间来审核并最终确定文档。