Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Open3D
- Teknik yazar:
- Rohan Rathi
- Projenin adı:
- Python ve C++ API ile ilgili Teknik Belgeler
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Özet:
Proje 4 bölüme ayrılacak: Open3D katkıda bulunanlar kılavuzunu yükseltme ve genişletme Python API belgelerini doldurma C++ API belgelerini doldurma Temel veri yapılarıyla ilgili üst düzey belgeler
Açıklama:
Projemde projeyi 4 bölüme ayırmayı planlıyorum:
Yeni başlayanlar için kaynak kodu oluşturma, belge oluşturma ve geliştirici topluluğuna katılma konusunda kapsamlı bir adım adım açıklamalı kılavuz içeren katkıda bulunanlar kılavuzunu tamamlamayı ve güncellemeyi planlıyorum. Yazılı bir kılavuza ek olarak, YouTube kanalı için kaynak kodunun nasıl oluşturulacağına ilişkin ayrıntılı adımları gösteren bir video hazırlamayı planlıyorum. Ayrıca, yeni geliştiricilerin pybind ve doksijen kullanılarak sfenks tarafından oluşturulan kaynak kodunda değişiklik yaparak bu belgelere nasıl katkıda bulunabileceklerine dair bir kılavuz da ekleyeceğim.
Python API belgelerini genişletin. Python API, şu anda sınıflar ve üye işlevleri için işlevlerin net bir açıklamasını sağlayan temel doküman dizelerini içerir. Python API belgelerini, API'nin daha kolay anlaşılmasını ve işlevselliğinin daha net anlaşılmasını sağlayacak şekilde yeniden ifade etmeyi planlıyorum. Ayrıca, farklı alanlarda kullanılan alakalı 3D grafik kavramlarına bağlantılar eklemeyi amaçlıyorum (Ör. Kamerada kullanılan doğal matris)
C++ API dokümanlarını tamamlayın. Şu anda C++ dokümanlarında Python dokümanlarına kıyasla eşdeğer docstring yoktur. Sınıfları, bunların ilişkili üye işlevlerini ve veri üyelerini ayrıntılı olarak belgelemek istiyorum .
Temel veri yapılarının üst ve alt düzey belgeleri. TriangleMesh, LineSet, Octree gibi çeşitli veri yapılarının kodunu anlamayı ve kod tabanına hem yeni geliştiricilerin anlaşılması hem de diğer kullanıcılara yorum eklemeyi amaçlıyorum. Ayrıca, eğiticileri geliştirerek yapılarda kullanım ve kavramlarla ilgili üst düzey dokümanlar sağlayın. Kullanımla ilgili ayrıntılı örnekler vereceğim ve yapılarda yer alan kavramlarla alakalı bağlantıları ekleyeceğim. Zaman kalırsa yeni gelen kullanıcıların yazılımla bağlantı kurmalarına 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ışıp kod tabanının farklı bölümlerinde gerekli belgelerle ilgili daha ayrıntılı bilgi verebilir, aynı zamanda alt ve üst düzey belgelerde ne kadar derinlemesine olunması gerektiğini tartışabilirsiniz. Bu zamanı kod tabanını anlamaya ve kavramları öğrenerek daha iyi belgelemeye de ayıracağım.
1. ve 2. Hafta:
Katkıda bulunanlar kılavuzunu güncelleyip genişleteceğim. Kaynak kodun nasıl oluşturulacağıyla ilgili dokümanları geliştireceğim. Yeni katkıda bulunanların dokümanlarda nasıl yardımcı olabileceğiyle ilgili bir belgeselciler bölümü de ekleyeceğim. Ayrıca kaynak kodun nasıl oluşturulacağını adım adım açıklayan bir YouTube videosu da hazırlayacağım.
3. Hafta - 5. Hafta:
Python API'yi genişletmek için çalışacağım. Mevcut belgeleri farklı şekilde ifade edin ve mevcut üyelerle ilgili belgeleri ayrıntılı olarak yazın. Ayrıca, kullanıcıların ilgili kavramları daha iyi tanıması için ilgili kavramlara alakalı bağlantılar da ekleyeceğim.
6. Hafta - 8. Hafta:
Mevcut C++ belgeleri kitaplığın büyük bir kısmı için eksik o yüzden zamanımın çoğunu C++ belgelerini doldurmaya harcayacağım
9. Hafta-11. Hafta:
Bu dönemde temel veri yapıları üzerinde çalışacağım. Her veri yapısının eğiticilerini yeniden yapılandırın, yüksek düzeyli bir genel bakış sağlayın ve örnek kullanım ayrıntılarını belgeleyin.
Son Hafta:
12 haftalık belgeleme dönemim boyunca yapılan çalışmaların nihai raporunu hazırlamak için son haftayı kullanacağım. Bu zamanı belgeleri incelemek ve tamamlamak için de ayıracağım.