Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Open3D
- Teknik yazar:
- Rohan Rathi
- Proje adı:
- Python ve C++ API ile İlgili Teknik Belgeler
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Özet:
Proje 4 bölüme ayrılacak: Open3D katkıda bulunan kılavuzunu yükseltme ve genişletme Python API dokümanlarını tamamlama C++ API dokümanlarını tamamlama Temel veri yapılarının üst düzey dokümanları
Açıklama:
Projemi 4 bölüme ayırmayı planlıyorum:
Yeni gelenler için kaynak kodu oluşturma, doküman oluşturma ve geliştirici topluluğuna katılmayla ilgili adım adım kapsamlı bir kılavuz sunan katkıda bulunanlar kılavuzunu tamamlayıp güncellemeyi planlıyorum. Yazılı bir kılavuza ek olarak, YouTube kanalının kaynak kodunu oluşturma adımlarını tam olarak gösteren bir video hazırlamayı planlıyorum. Ayrıca, yeni geliştiricilerin pybind ve doxygen kullanarak sphinx tarafından oluşturulan kaynak kodunda değişiklik yaparak dokümanlara nasıl katkıda bulunabileceğine dair bir kılavuz da ekleyeceğim.
Python API belgelerini genişletin. Şu anda Python API'si, sınıflar ve üye işlevler için işlevin belirsiz bir açıklamasını sağlayan temel docstring'ler içeriyor. Python API belgelerini, API'nin anlaşılmasını ve işlevlerinin daha net anlaşılmasını sağlayacak şekilde yeniden ifade etmeyi planlıyorum. Ayrıca, farklı alanlarda kullanılan ilgili 3D grafik kavramlarına ait bağlantılar eklemeyi de planlıyorum (ör. Kamera'da kullanılan içsel matris)
C++ API dokümanlarını inceleyin. Şu anda C++ dokümanlarında, Python dokümanlarındakine eşdeğer docstring'ler yoktur. Sınıfları, ilişkili üye işlevlerini ve veri üyelerini ayrıntılı olarak açıklamak istiyorum .
Temel veri yapılarının üst ve alt düzey dokümanları. TriangleMesh, LineSet, Octree gibi çeşitli veri yapılarının kodunu anlamak ve hem yeni geliştiricilerin anlaması hem de tüm kullanıcılar için kod tabanına yorum eklemek istiyorum. Ayrıca, eğiticileri iyileştirerek yapılarla ilgili kullanım ve kavramlar hakkında üst düzey dokümanlar sağlayın. Kullanımla ilgili ayrıntılı örnekler vereceğim ve yapılarla ilişkili kavramların bağlantılarını ekleyeceğim. Zaman kalırsa yeni kullanıcıların yazılımla ilişkilendirilmesine yardımcı olabilecek belirli görevlerin nasıl gerçekleştirileceğini belgelemek gibi daha basit görevler üzerinde çalışacağım.
Proje Zaman Çizelgesi-
1 Ağustos - 1 Eylül:
Mentorumla tanışın, kod tabanının farklı bölümlerinde gerekli olan belgeleme düzeyini daha derinlemesine tartışın ve ayrıca alt düzey ve üst seviye belgelerde nasıl ayrıntıya girileceğini tartışın. Bu süreyi, kod tabanını anlamaya ve kavramları daha iyi belgelemek için incelemeye ayıracağım.
1. ve 2. hafta:
Katkıda bulunanlar kılavuzunu güncelleyip genişleteceğiz. Kaynak kodunu derlemeyle ilgili dokümanları iyileştireceğiz. Ayrıca, yeni katkıda bulunanların dokümantasyona nasıl yardımcı olabileceğiyle ilgili bir dokümanlar bölümü de ekleyeceğim. Ayrıca, kaynak kodun nasıl oluşturulacağını adım adım açıklayan bir YouTube videosu hazırlayacağım.
3. - 5. Hafta:
Python API'yi genişletmek için çalışacağız. Mevcut dokümanları yeniden ifade edin ve mevcut üyelerle ilgili ayrıntılı dokümanlar yazın. Ayrıca, kullanıcıların ilgili kavramları daha iyi tanıyabilmeleri için ilgili kavramlara alakalı bağlantılar da ekleyeceğim.
6. - 8. hafta:
Mevcut C++ dokümanları, kitaplığın büyük bir kısmı için eksik olduğundan zamanımın çoğunu C++ dokümanlarını doldurarak geçireceğim.
9. - 11. hafta:
Bu süre zarfında temel veri yapıları üzerinde çalışacağım. Her bir veri yapısının eğitimlerini yeniden yapılandırın, üst düzey bir genel bakış sağlayın ve örnek kullanım ayrıntılarını belgeleyin.
Son Hafta:
12 haftalık belge dönemim boyunca yapılan çalışmaların son raporunu hazırlamak için son haftayı kullanacağım. Bu süreyi dokümanları inceleyip sonlandırmak için de kullanacağım.