DIPY projesi

Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.

Proje özeti

Açık kaynak kuruluşu:

DIPY

Teknik yazar:

Areesha Tarık

Proje adı:

Üst düzey yeniden yapılandırma ve son kullanıcı odağı

Proje süresi:

Standart uzunluk (3 ay)

Proje açıklaması

Yazılım Mühendisiyim ve teknik yazım uzmanıyım. Yüksek kaliteli yazılım belgeleri, kullanım kılavuzları, kılavuzlar ve proje açıklamaları yazma konusunda 4 yıldan fazla deneyime sahibim. İslamabad, Pakistan'da yaşıyorum (Saat dilimi: UTC + 5). Şu anda Sosyal Yardımda 18 Ağustos'a kadar stajyer olarak çalışıyorum. OpenELIS Global kuruluşunda teknik yazar olarak Google Dokümanlar'a katıldım. Orijinal dokümanlar Fransızca, sınırlı ve eskiydi; bu yüzden, İngilizce olarak kapsamlı ve güncellenmiş bir son kullanıcı dokümanı oluşturdum. Perl & Raku kuruluşunda, Mayıs-Ağustos 2020'de Open Food Facts sunucusunun arka uç geliştiricisi olarak seçildim. Arka uç geliştirmenin yanı sıra, bu stajın ana görevlerinden biri modüller ve işlevler için POD biçiminde dokümanlar oluşturmaktır. Geçen yıl birkaç açık kaynak projesine katkıda bulunup daha sonra Google Dokümanlar Sezonu'na katılarak açık kaynak dünyasına adım attım. Bu yıl, açık kaynak ve ücretsiz yazılımda çeşitliliği destekleyen Sosyal Yardım Programı'na seçildim. Sosyal yardım projem GitHub'da yürütüldüğünden Git'e çok hakimim. Mart ayından bu yana Open Food Facts ve Mozilla Fenix'e düzenli olarak katkıda bulunuyorum. 3 yıldan fazladır Linux kullanıcısıyım ve o zamandan beri terminal komutlarını kullanıyorum.

Kullandığım belge araçları ve diller Sfenks, Belgeleri okuyun ve Markdown. Bu fikri beğendim ve konuyla ilgili deneyime sahip olduğum için bilgi ve becerilerimi DIPY'ye katkıda bulunmak üzere kullanmayı çok isterim. Bu nedenle üzerinde çalışmak istiyorum. Dijital görüntü işleme, bilgisayar görüşü ve makine öğrenimi alanlarında deneyimim var. Bu, nörolojik görüntülemeyi daha iyi anlamama ve belge oluşturmada bana yardımcı olacak. Tıp alanında engin tecrübelerim var. Doktorlar, hastalar, laboratuvarlar, ambulans şoförleri için tıbbi bir web sitesi geliştirdim. Doktorlar, hastalar, hemşireler, laboratuvar asistanları ve araştırmacılar tarafından kullanılan başka bir sistem üzerinde çalıştım. Bu yöntem, kitlenin daha kolay anlayabileceği belgeler oluşturmama yardımcı olacak.

DIPY belgelerini gözden geçirdim ve belgelerdeki bazı kusurları not ettim. Dokümanlarda iyileştirmeyi planladığım birden çok güvenlik açığı var. Belgelerin Mevcut Durumu: Belgelerin belirli bir yapısı ve tasarımı yok Özellikle yeni kullanıcıların gezinmesi can 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 zorlanıyorum. Belgelerin, kullanıcının istediği bilgilere kolayca erişilebileceği şekilde yeniden şekillendirilmesi gerekir Belgelerde tutarlılık sağlanmıyor

Şunları yapmayı planlıyorum:

Belgeler için özel bir yapı ve şablon tanımlayın Kullanıcıların kolayca gezinebilecekleri ve gerekli bilgileri bulabilmeleri için dokümanları yeniden şekillendirin Topluluğu daha sonraki belge çalışmaları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 Kullanıcı rehberini, geliştirme kılavuzunu, geliştirme kılavuzunu yeniden yazın, yeniden yapılandırın ve güncelleyin, dokümantasyonu yeniden yazın, yeniden yapılandırın ve güncelleyin

Kullanıcı Rehberi:

Kullanıcı rehberi olarak kullanıcıların en karmaşık sistemleri bile anlamasına yardımcı olmak için basit ve yalın bir dil kullanmaya odaklanacağım. Yeni bir kullanıcının farkında olmayabileceği jargon ve kısaltmalar gibi içeriden alınan diğer bilgiler daha iyi bir kullanıcı deneyimi sağlamak için önlenir. Ayrıca kullanıcıya sistemin nasıl çalıştığını hızlı bir şekilde gösteren görseller, ek açıklamalı ekran görüntüleri, grafikler ve videolar gibi görsel içerikleri de kullanmaya odaklanacağım. İyi bir doküman için kullanıcı, her bölümün kendilerine ne göstereceğini anlaması için başlıklardan oluşan bir hiyerarşiye ihtiyaç duyar. Bu hiyerarşi, kullanıcının sistemi en faydalı şekilde kullanmayı öğrenmesine yardımcı olacak mantıksal bir akışı izlemelidir. Bu projenin ana hedeflerinden biri erişilebilir içerik oluşturmaktır. Tüm belgeler ve kılavuzlar tutarlı bir stile göre işlenir. Birden çok dokümanda tutarlı yazı tipleri ve birbirini tamamlayan renkler kullanmak zorunludur. Kullanıcıların, sistemde nasıl başarılı olacakları konusunda kuruluşun daha fazla kaynağına erişmesini sağlayacağım.

Geliştirici Kılavuzu:

Geliştirici kılavuzu, geliştiricinin DIPY kaynak koduna katkı oluşturmasına yardımcı olacak kapsamlı yönergeler ve referans materyaller içerir. Hedefinize bağlı olarak doğru yaklaşımı kullanabilmeniz için kullanabileceğiniz çeşitli seçenekleri ortaya koymaya çalışır. Geliştirme rehberinin yeniden şekillendirilmesi ve yapılandırılması gerekiyor. Geliştirici kılavuzu içeriğini yeniden yazacağım. Bağımlılık oluşturma, katkıda bulunma kılavuzu, stil kılavuzu, kodlama kuralları, belge kılavuzu, geliştirme ortamını yükleme, hata ayıklama, test kılavuzu ve ilgili öğeler dahil edilecek ve geliştiriciler tarafından kolayca erişilebilir hale getirilecektir. Yeni katkıda bulunanlar ilk açık kaynak katkılarını yapmak için projenize koştuğunda yol gösterici olarak katkıda bulunan yönergelerden yararlanır. Bu nedenle yönergeler kolay okunabilir, kapsamlı ve samimi olacaktır. Katkıda bulunma rehberleri, insanların açık kaynak projeye nasıl katkıda bulunabileceğini ileten yararlı belgelerdir. Projeye katkıda bulunmak, kullanıcılar için mümkün olduğunca kolay ve şeffaf hale getirilmelidir. Örneğin: Düzeltme göndermek Hata bildirme Yönetici olma Kodun mevcut durumunu tartışma Yeni özellikler önerme

TEMPLATE

Bu, katkı kılavuzu için kullanılabilecek şablonlardan biridir. Dokümanda değişiklik yapılabilir ve dokümanın gerekliliklerine göre bölümler eklenebilir veya kaldırılabilir.

DIPY'ye katkıda bulunuyor

• Hoş Geldiniz Notu

Kullanım Şartları

Davranış Kuralları

• Standartlarımız
• Olumlu bir ortam yaratmaya katkıda bulunan davranış örnekleri
• Katılımcıların kabul edilemez davranışlarına örnekler
• Sorumluluklarımız
• Proje yöneticilerinin sorumlulukları
• Kapsam

Davranış Kurallarının Kapsamı

Yardımcı olmak için bilmem gerekenler neler?

Kod katkısında yardımcı olmak istiyorsanız projemiz [projenizin kullandığı programlama dilleri, çerçeveler veya araçların listesini ekleyin]. Henüz kod için katkıda bulunmaya hazır hissetmiyorsanız sorun değil! Ayrıca belge sorunlarına [link to the docs label or tag on your issue tracker] veya [link to design label or tag on issue tracker on your project] (projeniz tasarım sorunlarını izliyorsa bağlantı) tasarım sorunlarına da göz atabilirsiniz. Kod katkısında bulunmak ve kullandığımız teknolojiler hakkında daha fazla bilgi edinmek isterseniz aşağıdaki listeye göz atın. Yeni katkıda bulunanların projeye katkıda bulunmak için kullanıcıların neleri bilmesi gerektiğini öğrenmek üzere kullanabilecekleri kaynakların (eğitici içerikler, videolar, kitaplar) madde işaretli bir listesini ekleyin.

Geliştirme ortamını ayarlama

Bu bölümde kurulum prosedürünü ve kurulması gereken bağımlılıkları ekleyeceğim. $project uygulamasını çalıştırarak yükleyin: proje yükleme

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

Katkıda Bulunma

Hata bildirme

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

Değişiklikler nasıl gönderilir?

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

Geliştirme isteğinde bulunma

• Geliştirme Önerisini Göndermeden Önce
• İyi Bir Geliştirme Önerisini Nasıl Gönderebilirim?

Koda ilk katkınız

• Yeni Başlayanlar İçin Sorunlar
• Yardım isteme sorunları #### Çekme İsteği
• Pull isteği oluşturma süreci
• 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 kaydetme mesajları
• Standart stil

Destek

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

Lisans

Bu bölümde projenin lisansı açıklanacaktır.

Zaman taahhüdü ve iletişim:

Haftada 45 saatten fazla zaman vereceğim, ancak herhangi bir aksilik durumunda hafta sonları o saatleri telafi edeceğim. Topluluk bağ döneminde, iletişim yöntemlerini tartışacak, haftalık toplantıları, araçları ve bu toplantıların zamanını mentorumla netleştireceğim. Mentoruma çalışmalarımla ilgili güncel bilgiler vereceğim ve çalışmamla ilgili ayrıntıları e-posta yoluyla mentorumla paylaşacağım. Ekran paylaşma gibi birçok özellikle kullanımı kolay olduğundan iletişim için TeamViewer'ı tercih ederim.