本页面包含有关 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 周的记录期内完成的工作。我还会花时间查看并最终完成文档。