このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソースの組織:
- Open3D
- テクニカル ライター:
- Rohan Rathi
- プロジェクト名:
- Python と C++ API の技術ドキュメント
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
あらすじ:
このプロジェクトは、Open3D コントリビューターのガイドのアップグレードと拡張、Python API ドキュメントの完全版、C++ API ドキュメントの完全版、コア データ構造の概要ドキュメントの 4 つのパートに分かれています。
説明:
私のプロジェクトでは、プロジェクトを次の 4 つのパートに分割する予定です。
新規参加者向けのコントリビューター ガイドを完成させて更新する予定です。このガイドでは、ソースコードのビルド方法、ドキュメントの作成方法、デベロッパー コミュニティへの参加方法について、包括的な手順を説明します。書面によるガイドに加えて、YouTube チャンネルのソースコードをビルドする正確な手順を示す動画も作成する予定です。また、新しいデベロッパーが pybind と doxygen を使用して Sphinx でビルドしたソースコードに変更を加えてドキュメントに貢献する方法に関するガイドも追加します。
Python API のドキュメントを拡張。現在、Python API には、クラスとメンバー関数の基本的な docstring が含まれており、機能をあいまいに説明できます。Python API のドキュメントを書き直し、API をよりわかりやすく、機能を明確にすることを計画しています。また、さまざまな分野で使用される関連する 3D グラフィックのコンセプト（カメラで使用される固有行列など）へのリンクも追加する予定です。
C++ API ドキュメントを完成させます。現在のところ、C++ のドキュメントには Python のドキュメントと同等の docstring がありません。クラスとそれに関連するメンバー関数、データメンバーについて詳しく解説します。
コア データ構造の詳細と概要に関するドキュメント。新しいデベロッパーにとってもすべてのユーザーにとっても、TriangleMesh、LineSet、Octree などのさまざまなデータ構造のコードを理解し、コードベースにコメントを追加するつもりです。また、チュートリアルを改善し、構造に関連する使用方法とコンセプトに関する概要ドキュメントを提供します。使用例を詳しく説明し、構造に関連するコンセプトに関連するリンクを追加します。時間に余裕があれば、新規ユーザーがソフトウェアに慣れ親しむのに役立つ特定のタスクの実行方法を記述するなど、より簡単なタスクに取り組みます。
プロジェクト スケジュール -
8 月 1 日～ 9 月 1 日:
私のメンターと知り合いになり、コードベースのさまざまな部分で必要となるドキュメントのレベルについて、さらに掘り下げて話し合ってください。また、ローレベルのドキュメントと概要レベルのドキュメントでどの程度深く掘り下げるかについて話し合うこともできます。また、この期間を利用してコードベースを理解し、概念を学習して、より適切に文書化できるようにします。
1 ～ 2 週目:
コントリビューター ガイドの更新と拡大を行う予定です。ソースコードをビルドする方法に関するドキュメントを改善します。また、新しいコントリビューターがドキュメントの作成をどのように支援できるかについて、ドキュメントのセクションも追加します。また、ソースコードをビルドする手順を説明した YouTube 動画も作成します。
第 3 ～ 5 週:
Python API の拡張に取り組んでいます。既存のドキュメントを書き直し、既存のメンバーについて詳しく記述します。また、関連するコンセプトへのリンクも追加し、ユーザーが関連するコンセプトをより深く理解できるようにします。
第 6 ～ 8 週:
現在の C++ ドキュメントは、ライブラリの大部分で不完全であるため、ほとんどの時間を C++ ドキュメントに書き留めます。
第 9 ～ 11 週:
この期間は、コア データ構造の開発に取り組みます。各データ構造のチュートリアルを再構成し、概要と使用例の詳細を記載しました。
最終週:
最終週は、12 週間の文書化期間中に行った作業の最終報告書を準備します。また、この期間を利用してドキュメントを確認して最終的な形にします。