Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Terbuka 3D
- Penulis teknis:
- Rohan Rathi
- Nama proyek:
- Dokumentasi Teknis Python & C++ API
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Sinopsis:
Project ini akan dibagi menjadi 4 bagian: Mengupgrade dan memperluas panduan kontributor Open3D Menyelesaikan dokumentasi Python API Menyelesaikan dokumentasi API C++ Dokumen tingkat tinggi tentang struktur data inti
Deskripsi:
Dalam proyek ini, saya berencana untuk membagi proyek menjadi 4 bagian:
Saya berencana menyelesaikan dan memperbarui panduan kontributor untuk pendatang baru yang menyediakan panduan komprehensif langkah demi langkah tentang cara membangun kode sumber, membangun dokumentasi, dan bergabung dengan komunitas developer. Selain panduan tertulis, saya bermaksud membuat video yang menampilkan langkah-langkah pasti terkait cara membuat kode sumber untuk channel YouTube. Saya juga akan menambahkan panduan tentang bagaimana developer baru dapat berkontribusi pada dokumentasi dengan membuat perubahan pada kode sumber yang dibuat oleh sphinx menggunakan pybind dan doxygen.
Perluas dokumentasi Python API. Saat ini Python API berisi docstring dasar untuk class dan fungsi anggota yang memberikan deskripsi fungsi yang samar-samar. Saya berencana menyusun ulang dokumentasi Python API yang membuat API lebih mudah dipahami dan fungsionalitasnya lebih jelas. Saya juga ingin menambahkan link ke konsep grafis 3D yang relevan dan digunakan di berbagai area (Misalnya: Matriks intrinsik yang digunakan di Kamera)
Lengkapi dokumentasi C++ API. Saat ini, tidak ada docstring yang setara dalam dokumentasi C++ jika dibandingkan dengan dokumentasi Python. Saya ingin mendokumentasikan class serta fungsi anggota terkait dan anggota data secara mendetail .
Dokumen tingkat tinggi dan rendah tentang struktur data inti. Saya ingin memahami kode berbagai struktur data seperti TriangleMesh, LineSet, Octree dan menambahkan komentar di codebase, baik untuk pemahaman developer baru maupun pengguna. Serta memberikan dokumentasi tingkat tinggi tentang penggunaan dan konsep yang terlibat dalam struktur dengan meningkatkan tutorial. Saya akan memberikan contoh penggunaan secara detail dan menambahkan tautan yang relevan ke konsep yang terlibat dalam struktur. Jika waktu memungkinkan, saya akan mengerjakan tugas yang lebih sederhana seperti mendokumentasikan cara melakukan tugas tertentu yang dapat membantu pengguna baru untuk berafiliasi dengan software tersebut.
Jadwal Project-
1 Agustus—1 September:
Berkenalan dengan mentor saya dan bahas secara lebih mendalam tingkat dokumentasi yang diperlukan di berbagai bagian codebase dan juga bahas secara mendalam cara melakukan dokumentasi tingkat rendah vs tingkat tinggi. Saya juga akan menghabiskan waktu ini untuk memahami codebase dan mempelajari konsepnya sehingga saya dapat mendokumentasikannya dengan lebih baik.
Minggu ke-1 & 2:
Saya akan memperbarui dan memperluas panduan kontributor. Saya akan memperbaiki dokumentasi tentang cara membangun kode sumber. Saya juga akan menambahkan bagian pendokumentasi tentang bagaimana kontributor baru dapat membantu dalam dokumentasi. Saya juga akan membuat video YouTube yang menentukan langkah demi langkah cara membangun kode sumber.
Minggu ke-3—5:
Saya akan berupaya memperluas Python API. Susun ulang dokumentasi yang ada dan tulis dokumentasi detail dari anggota yang ada. Saya juga akan menambahkan tautan yang relevan ke konsep terkait sehingga pengguna dapat lebih mengenal konsep yang terlibat.
Minggu ke-6—8:
Sebagian besar dokumen C++ saat ini tidak lengkap, jadi saya akan menghabiskan sebagian besar waktu untuk mengisi dokumen C++
Minggu ke-9—11:
Selama periode ini, saya akan mengerjakan struktur data inti. Menyusun ulang tutorial dari setiap struktur data, memberikan ikhtisar tingkat tinggi serta detail penggunaan contoh dokumen.
Minggu Terakhir:
Saya akan menggunakan minggu terakhir untuk mempersiapkan laporan akhir dari pekerjaan yang telah saya lakukan selama periode dokumentasi 12 minggu. Saya juga akan meluangkan waktu ini untuk meninjau dan menyelesaikan dokumentasi.