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