projekt INCF

Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.

Podsumowanie projektu

Organizacja open source:

INCF

Pisarz techniczny:

g.

Nazwa projektu:

Dokumentacja szkoleniowa LORIS z zakresu otwartej, reprodukcyjnej neuronauki

Długość projektu:

Długotrwałe (5 miesięcy)

Opis projektu

I. W skrócie

LORIS (Longitudinal Online Research and Imaging System) to internetowa platforma do zarządzania projektami na potrzeby badań nad neuroobrazami,która wspiera kilka inicjatyw Open Science. Dokumentacja odgrywa ważną rolę w LORIS. Dokumentacja pomaga użytkownikom i programistom LORIS poznać szczegóły oprogramowania, aby mogli lepiej wykorzystywać platformę i uczestniczyć w jego rozwoju. W międzyczasie powinniśmy także zaktualizować dokumentację LORIS. Ten projekt ma pomóc LORIS w ulepszaniu dokumentacji.

II. Bieżący stan

Organizacja LORIS obecnie korzysta z witryny GitHub Wiki, witryny Read the Docs i LORIS.ca, aby przechowywać całą dokumentację. W witrynie LORIS GitHub Wiki znajduje się największa ilość dokumentacji LORIS, a dodatkowe samouczki, prezentacje, przewodniki użytkownika i poradniki LORIS są hostowane na różnych platformach . Obecna dokumentacja LORIS zawiera przewodniki dla programistów i użytkowników LORIS, ale jej wprowadzenie może pomóc w dalszym rozwoju i organizacji zadań, zwłaszcza w zakresie aktualizacji dokumentacji i udoskonalania szczegółów technicznych.

III. Korzyści dla społeczności

Dzięki ulepszeniu dokumentacji szkoleniowej LORIS w zakresie otwartych, reprodukcyjnych neuronauki badacze i deweloperzy skorzystaliby z bardziej przyjaznego dla użytkownika narzędzia, które ułatwiłoby zbieranie danych w ich badaniach. W szczególności projekt może aktualizować i ulepszać dokumentację instalacji i konfiguracji LORIS, a także materiały szkoleniowe dla nowych użytkowników. Celem projektu jest również pomoc w migracji i aktualizacji dokumentacji z witryny wiki LORIS na GitHubie służącej do odczytywania dokumentów. W ramach projektu może też udostępnić diagram bazy danych, który umożliwi komunikację między danymi i ulepszy wizualizację architektury. Celem projektu jest też zaktualizowanie i ulepszenie treści przybliżających ludziom język LORIS, jego otwartego kontekstu naukowego oraz przypadków użycia.

IV. Mocne strony projektu

W ciągu ostatnich kilku lat brałem udział w kilku projektach technicznych, w ramach których zdobyłem bogate doświadczenie w pisaniu tekstów technicznych. W szczególności odpowiadałam za tworzenie dokumentacji we wcześniejszych projektach zespołowych. Uważam, że mam wystarczające doświadczenie w korzystaniu z narzędzi technicznych do pisania, takich jak Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX itp. Wcześniej moje wcześniejsze doświadczenie w nauczaniu z kursów nauk przyrodniczych, techniki, inżynierii i matematyki poprawiło moje umiejętności w zakresie komunikacji technicznej. Dokumentacja szkoleniowa LORIS dotycząca otwartych, reprodukcyjnych projektów z zakresu neuronauki we współpracy z INCF dawałaby mi doskonałą okazję, aby wykorzystać w LORIS moje techniczne techniki pisania. Poza tym bardzo interesuję się neuroobrazowaniem i próbuję zastosować w tym obszarze moją wiedzę techniczną. Dokumentacja szkoleniowa LORIS dotycząca otwartych, reprodukcyjnych projektów neurologicznych w ramach INCF byłaby dla mnie cennym doświadczeniem.

V. Materiały wynikowe

1. Przenieś i zaktualizuj bieżącą dokumentację LORIS
2. Przeglądanie, aktualizowanie i ulepszanie dokumentacji instalacji i konfiguracji LORIS oraz wypełnianie luk w materiałach szkoleniowych dla nowych użytkowników
3. Pomóż wygenerować diagram bazy danych, aby komunikować relacje między danymi (np. przedmiot wizyty, wizyta na zajęciach) i ulepszać wizualizację architektury
4. Pomóż zaktualizować i ulepszyć dokumentację interfejsu LORIS API
5. Pomagaj aktualizować i ulepszać treści, które przedstawiają język LORIS, otwarty kontekst naukowy i przypadki użycia w różnych formatach multimedialnych

VI. Oś czasu

Nawiązywanie więzi ze społecznością (17–13 września) a) Dokładne zapoznanie się z oprogramowaniem LORIS i przepływem pracy zespołu. b) Przejrzyj, zaktualizuj i ulepsz dokumentację dotyczącą instalacji i konfiguracji LORIS.

Tydzień 1 (14–20 września) Zaktualizuj i przenieś dokumentację LORIS z witryny wiki na GitHubie do sekcji Read the Docs.

Tydzień 2 (21–27 września) a) Zapoznaj się z aktualnymi materiałami dla użytkowników LORIS. b) Rozpoczęcie wypełniania luk w materiałach dla użytkowników LORIS poprzez udostępnienie im szkoleń na podstawie bieżącej dokumentacji.

Tydzień 3 (28 września–4 października) Wypełnianie luk w materiałach LORIS dla użytkowników końcowych, które zapewniają szkolenia dla nowych użytkowników.

Tydzień 4 (5–11 października) a) Zapoznanie się z obecną architekturą bazy danych LORIS. b) Rozpocznij wdrażanie schematu bazy danych na platformie LORIS.

Tydzień 5 (12–18 października) a) Wykonaj zadanie generowania diagramu bazy danych LORIS. b) Zapoznaj się z obecnym interfejsem LORIS API i zacznij pomagać w ulepszaniu dokumentacji API.

Tydzień 6 (19 października – 25 października) Kontynuuj prace nad ulepszeniem dokumentacji interfejsu API LORIS.

Tydzień 7 (26 października – 1 listopada) Zakończ ulepszenie dokumentacji interfejsu LORIS API.

Tydzień 8 (2–8 listopada) Zapoznaj się z aktualnymi materiałami na temat organizacji LORIS i zacznij aktualizować ten kontekst oraz zwiększać otwarty kontekst naukowy.

Tydzień 9 (9–15 listopada) Zakończenie aktualizacji i ulepszenie otwartego kontekstu naukowego w treści przedstawiania ludziom LORIS.

Tydzień 10 (16 – 22 listopada) Pomóż zaktualizować i ulepszyć niektóre przypadki użycia związane z treściami prezentującymi organizację LORIS.

Tydzień 11 (23–29 listopada) Dokończ aktualizację i ulepsz wszystkie przypadki użycia w treściach wprowadzających użytkowników do LORIS.

Finalizacja projektu (30 listopada – 5 grudnia) a) Usuń wszystkie utworzone przeze mnie materiały w dokumentacji. b) Scal wszystkie utworzone żądania pull na GitHubie i zamknij wszystkie utworzone przeze mnie żądania. c) Wypełnię ostateczny raport o projekcie i prześlij go do Google.

VII. Osiągnięcia w przyszłości

Po zakończeniu sezonu Dokumentów Google 2020 chcę nadal korzystać z dokumentacji LORIS. W szczególności chcę porozmawiać z deweloperami LORIS o możliwości dalszego aktualizowania i tworzenia dokumentacji dla nowych wersji. Chcielibyśmy też poświęcić trochę czasu na zapoznanie się z dokumentacją utworzoną w ramach mojego projektu Google Season of Docs i sprawdzenie, czy można coś poprawić. Ponieważ posiadam odpowiednie doświadczenie w zakresie inżynierii, chętnie pomogę w innych aspektach oprogramowania LORIS w przyszłości, np. w jego rozwoju.