DIPY projesi

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:

DIPY

Teknik yazar:

Areesha Tarık

Proje adı:

Yüksek düzeyde yeniden yapılanma ve son kullanıcı odaklı yaklaşım

Proje uzunluğu:

Standart uzunluk (3 ay)

Proje açıklaması

Yazılım mühendisiyim ve teknik yazı konusunda uzmanım. Yüksek kaliteli yazılım dokümanları, kullanıcı kılavuzları, el kitapları ve proje açıklamaları yazma konusunda 4 yılı aşkın deneyime sahibim. İslamabad, Pakistan'da yaşıyorum (Saat dilimi: UTC + 5). Şu anda Outreachy'de stajyer olarak çalışıyorum. Stajımın süresi 18 Ağustos'a kadar devam edecek. Google Dokümanlar Sezonu'na OpenELIS Global kuruluşunda teknik yazar olarak katıldım. Orijinal dokümanlar Fransızca, sınırlı ve güncel değildi. Bu nedenle, İngilizce olarak kapsamlı ve güncel bir son kullanıcı dokümanı oluşturdum. Mayıs-Ağustos 2020 dönemi için Perl & Raku kuruluşunda Open Food Facts sunucusunun arka uç geliştiricisi olarak Outreachy'ye seçildim. Bu stajın arka uç geliştirmenin yanı sıra en önemli görevlerinden biri, modüller ve işlevler için POD biçiminde dokümanlar oluşturmaktır. Açık kaynak dünyasına geçen yıl birkaç açık kaynak projesine katkıda bulunarak ve daha sonra Google Dokümanlar Sezonu'na katılarak adım attım. Bu yıl ise açık kaynak ve ücretsiz yazılım çeşitliliğine destek veren Outreachy programına seçildim. Outreachy projem GitHub'da barındırıldığı ve Mart ayından beri Open Food Facts ve Mozilla Fenix'e düzenli olarak katkıda bulunduğum için Git'i iyi biliyorum. Son 3 yıldan uzun süredir Linux kullanıcısıyım ve o zamandan beri terminal komutlarını kullanıyorum.

Kullandığım doküman araçları ve dilleri Sphinx, Read the docs, Markdown. Bu fikri beğendim ve üzerinde çalışmak istiyorum. Çünkü ilgili deneyime sahibim ve bilgimi ve becerilerimi DIPY'ye katkıda bulunmak için kullanmak isterim. Dijital görüntü işleme, bilgisayar görüşü, makine öğrenimi alanında deneyimliyim. Bu sayede, görüntüleme tıbbı hakkında daha fazla bilgi edinebilir ve dokümanlar oluşturabilirim. Tıp alanında büyük bir deneyimim var. Doktorlar, hastalar, laboratuvarlar ve ambulans şoförleri için tıbbi bir web sitesi geliştirdim. Doktorlar, hastalar, hemşireler, laboratuvar asistanları ve araştırmacıların kullandığı başka bir sistem üzerinde çalıştım. Bu sayede, kitlenin daha kolay anlayabileceği dokümanlar oluşturabilirim.

DIPY belgelerini inceledim ve dokümanlarda bazı kusurlar fark ettim. Dokümanda iyileştirme yapmayı planladığım birden fazla boşluk var. Dokümanların Mevcut Durumu: Dokümanlar belirli bir yapıya ve tasarıma sahip değil Özellikle yeni kullanıcıların gezinmesi sıkıcı ve zaman alıcı olabilir Kullanıcılar kılavuzdan bilgi edinmekte zorlanabilir Dokümanların içeriğinin iyileştirilmesi gerekiyor Yeni bir kullanıcı olarak kullanıcı kılavuzuna ve geliştirici kılavuzuna erişmekte zorlandım. Kullanıcının ihtiyaç duyduğu bilgilere kolayca erişilebilecek şekilde yeniden şekillendirilmesi gerekiyor. Belgelerde tutarlılık eksik

Aşağıdakileri yapmayı planlıyorum:

Dokümanlar için belirli bir yapı ve şablon tanımlayın Kullanıcıların kolayca gezinip gerekli bilgileri bulabileceği şekilde dokümanları yeniden şekillendirin Topluluğu daha fazla doküman çalışmasına dahil etmek için bir yol haritası veya çalışma öğeleri listesi oluşturun Kullanıcı kılavuzu ve geliştirici kılavuzu için şablonlar tanımlayın Katkı kılavuzu için şablonlar tanımlayın Kullanıcı kılavuzunu, geliştirme kılavuzunu ve katkı kılavuzunu yeniden yazın, yeniden yapılandırın ve güncelleyin (bu, yeni kullanıcıların projeye katkıda bulunmasına yardımcı olabilir ve onları motive edebilir) Metin açıklamalarını iyileştirmek için metin dışı resimler ekleyin Dokümanlar genelinde tutarlılığı iyileştirin Yeni komut satırı arayüzü için dokümanlar oluşturun

Kullanıcı Kılavuzu:

Kullanıcı rehberinde ise kullanıcıların en karmaşık sistemleri bile anlamalarına yardımcı olmak için basit ve sade bir dil kullanmaya odaklanırım. Daha iyi bir kullanıcı deneyimi için jargon, kısaltmalar ve yeni kullanıcıların bilmediği diğer bilgilerden kaçınılmalıdır. Ayrıca, kullanıcılara sistemin nasıl çalıştığını hızlıca gösteren resimler, not eklenmiş ekran görüntüleri, grafikler ve videolar gibi görsel içerikler kullanmaya da odaklanacağım. İyi bir dokümanda, kullanıcıların her bölümün neleri göstereceğini bilmesini sağlayan bir başlık ve alt başlık hiyerarşisi olmalıdır. Bu hiyerarşi, kullanıcının sistemi en yararlı şekilde kullanmayı öğrenmesine yardımcı olacak mantıklı bir akışa sahip olmalıdır. Bu projenin ana hedeflerinden biri erişilebilir içerikler oluşturmaktır. Tüm belgeler ve kılavuzlar tutarlı bir stile uygun olmalıdır. Birden fazla belgede tutarlı yazı tipleri ve birbirini tamamlayan renkler kullanmak şarttır. Kullanıcıların, sistemde başarılı olma konusunda kuruluşun daha fazla kaynağına erişebilmesini sağlayacağım.

Geliştirici Kılavuzu:

Geliştirici kılavuzu, geliştiricinin DIPY kaynak koduna katkıda bulunmasına yardımcı olacak kapsamlı rehberlik ve referans materyaller içerir. Bu sayede, ulaşmak istediğiniz hedefe bağlı olarak doğru yaklaşımı kullanabilirsiniz. Geliştirme kılavuzunun yeniden şekillendirilmesi ve yeniden yapılandırılması gerekiyor. Geliştirici kılavuzunun içeriğini yeniden yazacağım. Bağımlılık oluşturma, katkıda bulunan kılavuz, stil kılavuzu, kodlama kuralları, dokümantasyon kılavuzu, geliştirme ortamı yükleme, hata ayıklama, test kılavuzu ve ilgili öğeler dahil edilecek ve geliştiricilerin kolayca erişebileceği hale getirilecektir. İlk açık kaynak katkılarını yapmak için projenize gelen hevesli yeni katkıda bulunanlar, katkıda bulunma yönergelerinden yol gösterici olarak yararlanır. Böylece yönergeler kolay okunabilir, kapsamlı ve samimi olur. Katkı kılavuzları, kullanıcıların açık kaynaklı projeye nasıl katkıda bulunabileceğini anlatan yararlı belgelerdir. Projeye katkıda bulunma işlemi, kullanıcılar için mümkün olduğunca kolay ve şeffaf bir şekilde yapılmalıdır. Örneğin: Düzeltme gönderme Hata bildirme Geliştirici olma Kodun mevcut durumunu tartışma Yeni özellikler önerme

TEMPLATE

Bu, katkı rehberi için kullanılabilecek şablonlardan biridir. Bu şablon değiştirilebilir ve belgenin gereksinimlerine göre bölümler eklenebilir veya kaldırılabilir.

DIPY'ye katkıda bulunma

• Karşılama Notu

TOC

Davranış Kuralları

• Standartlarımız
• Olumlu bir ortam oluşturmaya katkıda bulunan davranışlara örnekler
• Katılımcıların kabul edilemez davranışlarına örnekler
• Sorumluluklarımız
• Projeyi koruyanların sorumlulukları
• Kapsam

Davranış Kuralları'nın Kapsamı

Size yardımcı olabilmem için bilmem gerekenler nedir?

Kod katkısında yardımcı olmak istiyorsanız projemizde [projenizin kullandığı programlama dilleri, çerçeveleri veya araçlarının listesini ekleyin] kullanılmaktadır. Henüz kod katkısında bulunmaya hazır değilseniz sorun değil. Ayrıca doküman sorunlarına [sorun izleyicinizdeki dokümanlar etiketine veya etiketine bağlantı] veya tespit ettiğimiz tasarım sorunlarına [projeniz tasarım sorunlarını izliyorsa sorun izleyicinizdeki tasarım etiketine veya etiketine bağlantı] da göz atabilirsiniz. Kod katkısında bulunmak istiyorsanız ve kullandığımız teknolojiler hakkında daha fazla bilgi edinmek istiyorsanız aşağıdaki listeye göz atın. Yeni katkıda bulunanların projeye katkıda bulunmak için bilmeleri gerekenleri öğrenmek üzere kullanabilecekleri kaynakların (eğitimler, videolar, kitaplar) madde işaretli bir listesini ekleyin.

Geliştirme ortamını ayarlama

Bu bölüme, yükleme prosedürünü ve yüklenmesi gereken bağımlılıkları ekleyeceğim. $project adlı projeyi şu komutu çalıştırarak yükleyin: proje yükleyin

• Kaynak Kodu: github.com/$project/$project
• Sorun İzleyici: github.com/$project/$project/issues

Katkıda Bulunma

Hata bildirme

• Hata Raporu Göndermeden Önce
• Nasıl (İyi) Hata Raporu Gönderebilirim?

Değişiklikleri gönderme

• Pull isteği protokolleri
• Ekipten yanıt
• Yanıt hızı

Geliştirme isteğinde bulunma

• Geliştirme Önerisi Göndermeden Önce
• How Do I Submit A (Good) Enhancement Suggestion?

İlk kod katkınız

• Yeni Başlayanlar İçin Sorunlar
• İstenen yardım sorunları #### Çekme İsteği
• Push isteği oluşturma işlemi
• Tüm durum kontrollerinin başarılı olduğunu doğrulayın.

Durum kontrolleri başarısız olursa ne olur?

• Yazma Testleri
• Test Kapsamı

Stil Kılavuzları

• Git commit mesajları
• Standart stil

Destek

Sorun yaşıyorsanız lütfen bize bildirin. Yardıma ihtiyacınız olursa [e-mail] adresindeki posta listemizde, IRC sohbetinde veya [projenizin kullandığı diğer iletişim platformlarını listeleyin] soru sorabilirsiniz.

Lisans

Bu bölümde projenin lisansı hakkında bilgi verilmektedir.

Zaman taahhüdü ve iletişim:

Haftada 45 saatten fazla çalışacağım ancak herhangi bir aksilik durumunda bu saatleri hafta sonlarında telafi edeceğim. Topluluk bağları dönemi boyunca, iletişim araçlarını tartışacak ve haftalık toplantıların zamanını, araçlarını ve şeklini mentörümle birlikte belirleyeceğim. Mentoruma çalışmalarımla ilgili güncel bilgiler sağlayacağım ve çalışmayla ilgili ayrıntıları e-posta aracılığıyla mentorumla paylaşacağım. Ekran paylaşımı gibi birçok özelliğiyle kullanımı kolay olduğu için iletişim için TeamViewer'ı tercih ederim.