このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Open3D
- テクニカル ライター:
- Rohan Rathi 氏
- プロジェクト名:
- Python および C++ API の技術ドキュメント
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
概要:
プロジェクトは以下の 4 つのパートに分かれています。 Open3D コントリビューター ガイドのアップグレードと拡張 Python API ドキュメントの完全版 C++ API ドキュメントの完成版 コアデータ構造の概要ドキュメント
説明:
私のプロジェクトでは、プロジェクトを 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 週:
コントリビューター ガイドを更新して拡張します。ソースコードのビルド方法に関するドキュメントを改善します。また、新しいコントリビューターがドキュメントの作成をどのように支援できるかについて、documenters セクションも追加します。また、ソースコードのビルド方法を順を追って説明する YouTube 動画も作成します。
第 3 ～ 5 週:
私は Python API の拡張に取り組みます。既存のドキュメントを言い換え、既存のメンバーに関する詳細なドキュメントを作成する。また、関連するコンセプトについてユーザーが理解を深められるように、関連するコンセプトへのリンクも追加します。
第 6 ～ 8 週:
現在の C++ ドキュメントはライブラリの大部分において不完全なため、ほとんどの時間をかけて C++ ドキュメントを記入します。
第 9 ～ 11 週:
この期間中に、コアデータ構造の開発に取り組みます。各データ構造のチュートリアルを再構成し、概要を説明して、使用例の詳細を説明します。
最終週:
最後の週に、12 週間の文書化期間に行った作業に関する最終報告書を準備する予定です。また、ドキュメントのレビューと最終調整にもこの時間をかけます。