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:
- INCF
- Teknik yazar:
- hq
- Proje adı:
- Açık ve tekrarlanabilir nörobilim için LORIS eğitim dokümanları
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
I. Soyut
Uzun Dönem Online Araştırma ve Görüntüleme Sistemi (LORIS), çeşitli Açık Bilim girişimlerini destekleyen, web'e açık bir nörogörüntüleme araştırması proje yönetimi platformudur. Belgeler, LORIS'te önemli bir rol oynar. Belgeler özellikle LORIS kullanıcılarının ve geliştiricilerinin yazılım ayrıntılarını anlamalarına yardımcı olur. Böylece kullanıcılar platformu daha iyi kullanabilir veya yazılım geliştirmeye katkıda bulunabilirler. Bu sırada LORIS dokümanları da güncellenmelidir. Bu proje, LORIS'in belgelerini iyileştirmesine yardımcı olmayı amaçlamaktadır.
II. Mevcut Durum
LORIS şu anda tüm dokümanları barındırmak için Github Wiki, Read the Docs ve LORIS.ca web sitesini kullanıyor. Özellikle LORIS GitHub Wiki, en fazla miktarda LORIS dokümanlarına ev sahipliği yapar. Diğer LORIS eğitimleri, sunumları, kullanıcı kılavuzları ve açıklamalı kılavuzları ise çeşitli platformlarda barındırılır. Mevcut LORIS dokümanları, LORIS geliştiricileri ve kullanıcıları için kılavuzlar sağlar ancak özellikle doküman güncellemeleri ve teknik ayrıntılardaki iyileştirmeler açısından daha fazla geliştirme ve düzenlemeden yararlanabilir.
III. Topluluğa Sağladığı Avantajlar
Açık ve yeniden üretilebilir nörobilim için LORIS eğitim dokümanlarını iyileştirerek araştırmacılar ve geliştiriciler, çalışmalarında veri toplamayı iyileştirmek için daha kullanıcı dostu bir araçtan yararlanabilir. Proje kapsamında, LORIS kurulum/ayar dokümanları ve yeni kullanıcılara eğitim sağlayan son kullanıcı dokümanları güncellenebilir ve iyileştirilebilir. Ayrıca proje, LORIS GitHub wiki'sindeki dokümanları Read the Docs'a taşımaya ve güncellemeye yardımcı olmayı da amaçlamaktadır. Bu arada proje, veri ilişkilerini iletmek ve mimari görselleştirmeyi iyileştirmek için bir veritabanı diyagramı sağlayabilir. Son olarak, bu proje kapsamında kullanıcıları LORIS'e, açık bilim bağlamına ve kullanım alanlarına tanıtan içerikler güncellenecek ve iyileştirilecek.
IV. Projeyle ilgili kişisel güçlü yönler
Geçtiğimiz birkaç yıl içinde birçok teknik projeye katıldım. Bu projelerde teknik yazarlık konusunda güçlü bir altyapım oldu. Daha açık belirtmek gerekirse, geçmişte birden fazla ekip projesinde doküman yazımından sorumluydum ve Read the Docs, Sphinx, Mkdocs, markdown, LaTeX gibi teknik yazım araçlarını kullanma konusunda yeterli deneyime sahip olduğumu düşünüyorum. Ayrıca, STEM kurslarında edindiğim önceki öğretim deneyimi, teknik iletişim becerilerimi de geliştirdi. INCF ile birlikte açık ve yeniden üretilebilir sinirbilim projeleri için LORIS eğitim dokümanları, teknik yazma tekniklerimi LORIS'e uygulamam için mükemmel bir fırsat olacak. Dahası, nörogörüntüleme alanıyla çok ilgileniyorum ve teknik bilgimi bu alana uygulama fırsatı bulmaya çalışıyorum. INCF ile açık ve yeniden üretilebilir sinirbilim projeleri için LORIS eğitim dokümanları benim için değerli bir deneyim olur.
V. Teslimatlar
- Mevcut LORIS dokümanlarını taşıma ve güncelleme
- LORIS kurulum/ayar dokümanlarını inceleyip güncelleyin ve iyileştirin, yeni kullanıcılara eğitim sağlayan son kullanıcı materyallerindeki boşlukları doldurun
- Veri ilişkilerini (ör. konu, çalışma ziyareti) iletmek ve mimari görselleştirmeyi iyileştirmek için bir veritabanı şeması oluşturmaya yardımcı olun
- LORIS API dokümanlarını güncelleme ve iyileştirmeye yardımcı olma
- Kullanıcıları LORIS'e, açık bilim bağlamına ve birden fazla medya biçimini içeren kullanım alanlarına tanıtan içeriklerin güncellenmesine ve iyileştirilmesine yardımcı olun
VI. Zaman çizelgesi
Toplulukla Bağlantı Kurma (17 Ağustos - 13 Eylül) a) LORIS yazılımı ve ekip iş akışıyla ilgili bilgi edinme sürecini tamamlayın. b) LORIS kurulum/ayar dokümanlarını inceleyin, güncelleyin ve iyileştirin.
1. Hafta (14 - 20 Eylül) LORIS dokümanlarını güncelleyip GitHub wiki'den Read the Docs'a 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ğlayan LORIS son kullanıcı materyallerindeki boşlukları doldurmaya başlamak.
3. Hafta (28 Eylül - 4 Ekim) Yeni kullanıcılar için eğitim sağlayarak LORIS son kullanıcı materyallerini doldurarak boşlukları tamamlayın.
4. Hafta (5 Ekim - 11 Ekim) a) Mevcut LORIS veritabanı mimarisini anlayın. b) LORIS platformu için veritabanı şemasını uygulamaya başlayın.
5. Hafta (12-18 Ekim) a) LORIS veritabanı şeması oluşturma görevini tamamlayın. b) Mevcut LORIS API'yi inceleyin ve API dokümanlarını iyileştirmeye başlayın.
6. Hafta (19 Ekim - 25 Ekim) LORIS API dokümantasyonunu iyileştirme çalışmaları devam ediyor.
7. Hafta (26 Ekim - 1 Kasım) LORIS API dokümanlarında iyileştirmeleri tamamlama.
8. Hafta (2 Kasım - 8 Kasım) Kullanıcıların LORIS ile tanışmasını sağlayan 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ın LORIS ile tanışmasını sağlayan içerikte açık bilim bağlamıyla ilgili güncellemeleri ve iyileştirmeleri tamamlayın.
10. Hafta (16 Kasım - 22 Kasım) Kullanıcıların LORIS ile tanışmasını sağlayan içeriklerdeki kullanım alanlarından bazılarını güncellememize ve iyileştirmemize yardımcı olun.
11. Hafta (23 Kasım - 29 Kasım) Kullanıcıların LORIS ile tanışmasını sağlayan içeriklerdeki tüm kullanım alanlarını güncelleyip iyileştirmeyi tamamlayın.
Projeyi tamamlama (30 Kasım - 5 Aralık) a) Oluşturduğum tüm doküman katkılarını temizleyin. b) GitHub'da oluşturulan tüm çekme isteklerini birleştirin ve oluşturduğum tüm sorunları kapatın. c) Nihai proje raporumu tamamlayıp Google'a gönderin.
VII. Gelecekteki Teslimatlar
Google Dokümanlar 2020 Mevsimi'nden sonra, LORIS ile ilgili dokümanlarla ilgili katkılarıma devam etmek istiyorum. Özellikle LORIS geliştiricileriyle yeni sürümler için dokümanları güncellemeye ve oluşturmaya devam etme olasılığı hakkında görüşmek istiyorum. Ayrıca, Google Dökümanlar Sezonu projemde oluşturduğum belgeleri incelemek ve iyileştirilebilecek daha fazla alan olup olmadığını kontrol etmek için biraz daha zaman ayırmak istiyorum. Son olarak, ilgili bir mühendislik geçmişim olduğu için gelecekte LORIS yazılımının diğer yönlerine (ör. yazılım geliştirme) katkıda bulunmaya hazırım.