Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Open3D
- Penulis teknis:
- Rohan Rathi
- Nama proyek:
- Dokumentasi Teknis Python & C++ API
- Durasi project:
- Durasi standar (3 bulan)
Project description
Sinopsis:
Project ini akan dibagi menjadi 4 bagian: Mengupgrade dan memperluas panduan kontributor Open3D Melengkapi dokumentasi Python API Melengkapi dokumentasi C++ API Dokumen tingkat tinggi tentang struktur data inti
Deskripsi:
Dalam project saya, saya berencana membagi project menjadi 4 bagian:
Saya berencana menyelesaikan dan memperbarui panduan kontributor untuk pendatang baru yang memberikan panduan langkah demi langkah yang komprehensif tentang cara mereka mem-build kode sumber, mem-build dokumentasi, dan bergabung dengan komunitas developer. Selain panduan tertulis, saya ingin membuat video yang menampilkan langkah-langkah yang tepat tentang cara mem-build kode sumber untuk channel YouTube. Saya juga akan menambahkan panduan tentang cara developer baru berkontribusi pada dokumentasi dengan membuat perubahan pada kode sumber yang dibuat oleh sphinx menggunakan pybind dan doxygen.
Memperluas dokumentasi Python API. Saat ini, Python API berisi docstring dasar untuk class dan fungsi anggota yang memberikan deskripsi fungsi yang tidak jelas. Saya berencana untuk menyusun ulang dokumentasi Python API yang membuat API lebih mudah dipahami dan fungsinya lebih jelas. Saya juga bermaksud menambahkan link ke konsep grafis 3D relevan yang digunakan di berbagai area (Misalnya: Matriks intrinsik yang digunakan di Kamera)
Selesaikan dokumentasi C++ API. Saat ini tidak ada docstring yang setara dalam dokumentasi C++ jika dibandingkan dengan dokumentasi Python. Saya ingin mendokumentasikan class dan fungsi anggota serta anggota data terkait secara mendetail .
Dokumen tingkat tinggi dan rendah dari 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. Selain itu, kami juga menyediakan dokumentasi tingkat tinggi tentang penggunaan dan konsep yang terlibat dalam struktur dengan meningkatkan kualitas tutorial. Saya akan memberikan contoh penggunaan 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 berafiliasi dengan software.
Project Schedule-
1 Agustus - 1 September:
Berkenalan dengan mentor saya dan membahas secara lebih mendalam tingkat dokumentasi yang diperlukan di berbagai bagian codebase, serta membahas seberapa mendalam dokumentasi tingkat rendah vs dokumentasi tingkat tinggi. Saya juga akan menghabiskan waktu ini untuk memahami codebase dan mempelajari konsepnya agar dapat mendokumentasikannya dengan lebih baik.
Minggu ke-1 & 2:
Kami akan memperbarui dan memperluas panduan kontributor. Saya akan meningkatkan kualitas dokumentasi tentang cara mem-build kode sumber. Kami juga akan menambahkan bagian pembuat dokumen tentang cara kontributor baru dapat membantu dalam dokumentasi. Saya juga akan membuat video YouTube yang menjelaskan langkah demi langkah cara mem-build kode sumber.
Minggu ke-3—5:
Saya akan berupaya memperluas Python API. Susun ulang dokumentasi yang ada dan tulis dokumentasi pelanggan yang sudah ada secara mendetail. Saya juga akan menambahkan link yang relevan ke konsep terkait sehingga pengguna dapat lebih memahami konsep yang terlibat.
Minggu ke-6—8:
Dokumen C++ saat ini tidak lengkap untuk sebagian besar library, jadi saya akan menghabiskan sebagian besar waktu untuk mengisi dokumen C++
Minggu ke-9—11:
Selama periode ini, saya akan mengerjakan struktur data inti. Susun ulang tutorial setiap struktur data, berikan ringkasan tingkat tinggi serta dokumentasikan contoh detail penggunaan.
Minggu Terakhir:
Saya akan menggunakan minggu terakhir untuk menyiapkan laporan akhir tentang pekerjaan yang dilakukan selama periode dokumentasi 12 minggu. Saya juga akan menggunakan waktu ini untuk meninjau dan menyelesaikan dokumentasi.