DIPY projesi

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:

DİPY

Teknik yazar:

Areesha Tarık

Projenin 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ıcı rehberleri, kılavuzlar ve proje açıklamaları yazma konusunda 4 yılı aşkın deneyime sahibim. Pakistan'ın İslamabad şehrinde yaşıyorum (Saat dilimi: UTC + 5). Şu anda Out Reachy'de stajyer olarak 18 Ağustos'a kadar çalışıyorum. OpenELIS Global adlı kuruluşta teknik yazar olarak Google Season of Docs'a katıldım. Orijinal dokümanlar Fransızca, sınırlı ve eski olduğundan İngilizce olarak kapsamlı ve güncellenmiş bir son kullanıcı dokümanı oluşturdum. Mayıs-Ağustos 2020'de Open Food Facts sunucusunun arka uç geliştiricisi olarak Perl & Raku kuruluşunda Sosyal Yardım'da seçildim. Arka uç geliştirmenin yanı sıra, bu stajın en önemli 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ıldığımda 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ımlar programına seçildim. Sosyal Yardım projem GitHub'da yürütüldüğü için Git'e çok hakimim. Mart ayından beri Open Food Facts ve Mozilla Fenix'e düzenli olarak katkıda bulunuyorum. 3 yılı aşkın süredir Linux kullanıcısıyım ve o zamandan beri terminal komutlarını kullanıyorum.

Kullandığım belge araçları ve dilleri Sfenks, Belgeleri okuma ve Markdown. Bu fikir hoşuma gitti; bununla ilgili deneyime sahip olduğum ve bilgim ile becerilerimi DIPY'ye katkıda bulunmak için kullanmak isterim. Bu yüzden bu fikir ü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şturma konusunda 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 sayede kitlem tarafından daha kolay anlaşılabilecek belgeler oluşturabilirim.

DIPY belgelerini inceledim ve belgelerde bazı kusurları tespit ettim. Dokümanlarda iyileştirmeyi planladığım birçok güvenlik açığı var. Belgenin Şu Anki Durumu: Belgenin belirli bir yapısı ve tasarımı yok Belgenin 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 zorlandım. Belgelerin, kullanıcı tarafından istenen bilgilere kolayca erişilebilecek şekilde yeniden şekillendirilmesi gerekir. Dokümanlar tutarlılık sağlamıyor

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

Belgeler için belirli bir yapı ve şablon tanımlayın Kullanıcıların kolayca gezinip gerekli bilgilere ulaşabilmesi için dokümanları yeniden şekillendirin Topluluğun daha fazla belge çalışmasına olanak tanımak 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ıda bulunmak için şablonlar tanımlayın Kullanıcı kılavuzunu, geliştirme kılavuzunu, geliştirme kılavuzunu ve katkıda bulunan kılavuzu yeniden yazın, yeniden yapılandırın ve güncelleyin (Bu, yeni resimlerde tutarlılık sağlamaya yardımcı olur ve projede metin-metini iyileştirmeye yardımcı olabilir ve onları motive edebilir)

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 odaklanırım. Yeni bir kullanıcının bilmediğ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çerikler kullanmaya odaklanacağım. İyi bir belgelemede, kullanıcıya her bölümün onlara ne gösterileceğini anlaması için bir başlık ve alt başlık hiyerarşisi gerekir. 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 uyacaktır. Birden çok dokümanda tutarlı yazı tipleri ve birbirini tamamlayan renkler kullanmak olmazsa olmazdır. Kullanıcıların kurumdaki sistemde başarılı olmak için daha fazla kaynağa erişmesini sağlayacağım.

Geliştirici Kılavuzu:

Geliştirici kılavuzu, geliştiricinin DIPY kaynak koduna katkı yapmasına yardımcı olacak kapsamlı yönergeler ve referans materyaller içerir. Neye ulaşmak istediğinize bağlı olarak doğru yaklaşımı kullanabilmeniz için kullanabileceğiniz çeşitli seçenekleri sunmaya çalışır. Geliştirme kılavuzunun yeniden şekillendirilmesi ve yapılandırılması gerekiyor. Geliştirici kılavuzunun 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ın kurulumu, hata ayıklama, test kılavuzu ve ilgili öğeler dahil edilecek ve geliştiriciler tarafından kolayca erişilebilir hale getirilecektir. Hevesli yeni katkıda bulunanlar ilk açık kaynak katkılarını yapmak için projenize koştuklarında kendilerine rehberlik etmesi için katkıda bulunan yönergelere güvenirler. Bu sayede yönergeler kolay okunabilir, kapsamlı ve samimi olacaktır. Katkıda bulunan rehberler, insanların açık kaynak projesine nasıl katkıda bulunabileceğini anlatan faydalı belgelerdir. Kullanıcılar açısından, projeye katkıda bulunmanın mümkün olduğu kadar kolay ve şeffaf olması gerekir. Örneğin: Düzeltme göndermek Hata bildirme Düzenleyici olmak Kodun mevcut durumunu tartışma Yeni özellikler sunmak

TEMPLATE

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

DIPY'ye katkı

• Hoş Geldiniz Notu

İçindekiler

Davranış Kuralları

• Standartlarımız
• Olumlu bir ortam oluşturulmasına 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 kodla katkıda bulunmaya hazır hissetmiyorsanız sorun değil! Ayrıca doküman sorunlarına [link to the docs label or tag on your issue Tracker] veya [link to design label or tag on issue tracker] tasarım sorunlarına da göz atabilirsiniz. Kod katkısında bulunmak 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 kullanıcıların neleri bilmeleri gerektiğini öğrenmek üzere kullanabileceği 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 yüklenmesi gereken bağımlılıkları ekleyeceğim. $project eklentisini ç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) Hata Raporunu Nasıl Gönderebilirim?

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

• Pull isteği protokolleri
• Ekipten gelen 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?

İlk kod katkınız

• Yeni Başlayanlar için Sorunlar
• Yardım istenen sorunlar #### Pull İ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 ihtiyaç duyarsanız [e-mail], IRC sohbeti veya [projenizin kullandığı diğer iletişim platformlarını listeleyin] adresindeki posta listemize soru sorabilirsiniz.

Lisans

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

Zaman taahhüdü ve iletişim:

Haftada 45 saatten fazla zaman veriyorum ancak herhangi bir aksilik durumunda hafta sonları bu çalışma saatlerini telafi edeceğim. Topluluk bağı dönemi boyunca iletişim yöntemlerini tartışacağım ve bu toplantıların yapılması için gereken haftalık toplantıları, araçları ve zamanları mentorumla sonlandıracağım. Mentorumu çalışmam hakkında bilgilendireceğim ve çalışmayla ilgili ayrıntıları e-posta yoluyla mentoruma paylaşacağım. Ekran paylaşma gibi birçok özellikle kullanımı kolay olduğundan iletişim için TeamViewer'ı tercih ediyorum.