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:
- INCF
- Teknik yazar:
- hq
- Projenin adı:
- Açık tekrarlanabilir nörobilim için LORIS eğitim belgeleri
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
I. Özet
Longitudinal Online Research and Imaging System (LORIS), birçok Open Science girişimini destekleyen, nörogörüntüleme araştırmaları için web'e yönelik bir proje yönetimi platformudur. Belgeleme LORIS'de önemli bir rol oynar. Belgeler özellikle LORIS kullanıcılarının ve geliştiricilerinin yazılım ayrıntılarını anlamasına yardımcı olur. Böylece, platformu daha iyi kullanabilir veya yazılım geliştirmeye katkıda bulunabilirler. Bu sırada LORIS belgeleri de güncellenmelidir. Bu proje, LORIS'in belgelerini iyileştirmesine yardımcı olmayı amaçlamaktadır.
II. Mevcut Durum
LORIS şu anda tüm belgeleri barındırmak için GitHub Wiki, Read the Docs ve LORIS.ca web sitesini kullanıyor. Özellikle, LORIS GitHub Wiki'de en fazla LORIS dokümanı vardır. Ek LORIS eğitimleri, sunumlar, kullanıcı rehberleri ve adım adım açıklamalı kılavuzlar da çeşitli platformlarda barındırılmaktadır. Mevcut LORIS belgeleri, LORIS geliştiricileri ve kullanıcıları için kılavuzlar sunar ancak özellikle belge güncellemeleri ve teknik ayrıntılardaki iyileştirmeler için geliştirme ve düzenleme imkanından yararlanabilir.
III. Topluluğa faydaları
Araştırmacılar ve geliştiriciler, açık tekrarlanabilir nörobilimler için LORIS eğitim dokümanlarını geliştirerek, çalışmalarında veri toplamayı iyileştirmek amacıyla daha kullanıcı dostu bir araçtan yararlanabilirler. Özellikle, proje yeni kullanıcılara eğitim veren son kullanıcı materyallerinin yanı sıra LORIS kurulum/kurulum belgelerini güncelleyip iyileştirebilir. Ayrıca proje, LORIS GitHub wiki'deki belgelerin Dokümanları Okuma'ya taşınmasına ve güncellenmesine yardımcı olmayı amaçlamaktadır. Bu sırada proje, veri ilişkilerini iletmek ve mimari görselleştirmeyi iyileştirmek için bir veritabanı diyagramı sağlayabilir. Son olarak bu proje, LORIS'i, açık bilim bağlamını ve kullanım alanlarını tanıtan içeriği güncelleyip iyileştirecektir.
IV. Projenin kişisel güçlü yönleri
Geçtiğimiz birkaç yıl içinde çeşitli teknik projelerde yer aldım. Bu projeler aracılığıyla teknik yazı konusunda güçlü bir altyapım oldu. Özellikle, geçmişteki birçok ekip projesinde belge yazmaktan sorumluydum ve Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX gibi teknik yazı araçlarının kullanımı konusunda yeterli deneyime sahip olduğumu düşünüyorum. Bu esnada, önceden STEM derslerinde ders verdiğim tecrübelerim, teknik iletişim becerilerimi de geliştirdi. INCF ile açık, tekrarlanabilir nörobilim projeleri için LORIS eğitim belgeleri, teknik yazma tekniklerimi LORIS'e uygulamam için mükemmel bir fırsat olurdu. Ayrıca, nörolojik görüntüleme alanına büyük ilgi duyuyorum ve teknik bilgilerimi bu alanda kullanmak için fırsatlar bulmaya çalışıyorum. INCF ile açık ve tekrarlanabilir nörobilim projeleri için LORIS eğitim belgeleri benim için değerli bir deneyim olurdu.
V. Teslimatlar
- Mevcut LORIS belgelerini taşıyın ve güncelleyin
- LORIS kurulum/kurulum belgelerini inceleyin, güncelleyin ve iyileştirin ve yeni kullanıcılara eğitim sağlamak için son kullanıcı materyallerindeki boşlukları doldurun
- Veri ilişkilerini (ör. konu, çalışma ziyareti) iletmek ve mimari görselleştirmesini iyileştirmek için bir veritabanı diyagramı oluşturulmasına yardımcı olur
- LORIS API belgelerinin güncellenmesine ve iyileştirilmesine yardımcı olun
- Kullanıcıları LORIS'i, açık bilim bağlamını ve birden fazla medya biçimini içeren kullanım alanlarını tanıtan içeriğin güncellenmesine ve iyileştirmeye yardımcı olun
VI. Zaman çizelgesi
Topluluk Bağları (17 Ağustos - 13 Eylül) a) LORIS yazılımını ve ekip iş akışını tam olarak tanıma. b) LORIS kurulum/kurulum belgelerini inceleyin, güncelleyin ve iyileştirin.
1. Hafta (14 Eylül - 20 Eylül) Dokümanlar'ı Okumak için GitHub wiki'sindeki LORIS belgelerini güncelleyin ve taşıyın.
2. Hafta (21 Eylül-27 Eylül) a) Mevcut LORIS son kullanıcı materyallerini inceleyin. b) Mevcut belgelere dayanarak yeni kullanıcılara eğitim sağlayarak LORIS son kullanıcı materyallerindeki boşlukları doldurmaya başlamak.
3. Hafta (28 Eylül - 4 Ekim) Yeni kullanıcılara eğitim sağlayarak LORIS son kullanıcı materyallerini doldurmak.
4. Hafta (5 Ekim - 11 Ekim) a) Mevcut LORIS veritabanı mimarisini anlama. b) LORIS platformu için veritabanı diyagramını uygulamaya başlama.
5. Hafta (12 Ekim - 18 Ekim) a) LORIS veritabanı diyagramı oluşturma görevini tamamlayın. b) Mevcut LORIS API'yi inceleyin ve API belgelerini iyileştirmeye yardımcı olmaya başlayın.
6. Hafta (19 Ekim - 25 Ekim) LORIS API belgelerini iyileştirmek için çalışmaya devam edin.
7. Hafta (26 Ekim - 1 Kasım) LORIS API belgelerindeki iyileştirmeyi tamamlayın.
8. Hafta (2 Kasım - 8 Kasım) İnsanları LORIS'le tanıştıran mevcut içeriği inceleyin ve açık bilim bağlamını güncellemeye ve iyileştirmeye başlayın.
9. Hafta (9 Kasım - 15 Kasım) Kullanıcıları LORIS'le tanıştırma içeriğinde açık bilim bağlamına yönelik güncellemeleri ve iyileştirmeleri tamamlayın.
10. Hafta (16 Kasım-22 Kasım) Kullanıcıları LORIS'le tanıştıran içeriklerdeki kullanım alanlarının bir kısmının güncellenmesine ve iyileştirilmesine yardımcı olun.
11. Hafta (23 Kasım - 29 Kasım) Kullanıcıları LORIS'le tanıştıran içeriklerdeki tüm kullanım alanlarının güncellenmesini ve iyileştirilmesini tamamlayın.
Proje Sonlandırma (30 Kasım - 5 Aralık) a) Oluşturduğum tüm belge katkılarını temizleyin. b) Oluşturulan tüm pull isteklerini GitHub'da birleştirin ve oluşturduğum tüm sorunları kapatın. c) Nihai proje raporumu tamamlayın ve raporu Google'a gönderin.
VII. Gelecekteki Teslimatlar
Dokümanlar Google Sezon 2020'den sonra LORIS belgelerine katkı yapmaya devam etmek istiyorum. Özellikle, yeni sürümler için doküman oluşturmaya ve güncellemeye devam etme olanağını LORIS geliştiricileriyle görüşmek isterim. Ayrıca, Google Dokümanlar Sezonu projem sırasında oluşturduğum dokümanları incelemek ve geliştirilebilecek başka alanlar olup olmadığını kontrol etmek için biraz zaman ayırmak istiyorum. Son olarak, mühendislikle ilgili deneyime sahip olduğum için gelecekte LORIS yazılımının diğer yönlerine (ör. yazılım geliştirme) katkıda bulunmaya açıkım.