Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source
- INCF
- Pisarz techniczny:
- hq
- Nazwa projektu:
- Dokumentacja szkolenia LORiS dotycząca otwartych, możliwych do odtworzenia metod neurotechnologii
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
I. Streszczenie
System badań i obrazowania online (LORIS) to internetowa platforma do zarządzania projektami dotyczącymi badań obrazowania mózgu,która obsługuje kilka inicjatyw związanych z otwartą nauką. Dokumentacja odgrywa ważną rolę w systemie LORIS. Dokumentacja pomaga użytkownikom i deweloperom LORIS zrozumieć szczegóły oprogramowania, aby mogli lepiej korzystać z platformy lub mieć wkład w rozwój oprogramowania. Tymczasem należy też zaktualizować dokumentację LORIS. Celem tego projektu jest pomoc LORIS w ulepszaniu dokumentacji.
II. Bieżący stan
Obecnie LORIS hostuje całą dokumentację w witrynie Github Wiki, Read the Docs i LORIS.ca. Najwięcej dokumentacji LORIS znajduje się na stronie LORIS GitHub Wiki, a dodatkowe samouczki, prezentacje, przewodniki użytkownika i instrukcje są hostowane na różnych platformach . Obecna dokumentacja LORIS zawiera przewodniki dla programistów i użytkowników LORIS, ale może przydać się na dalszy rozwój i większą organizację tych usług, zwłaszcza w aktualizacji dokumentacji i ulepszeniach w szczegółach technicznych.
III. Korzyści dla społeczności
Dzięki ulepszeniu dokumentacji szkoleniowej LORIS pod kątem otwartej powtarzalnej neuronauki badacze i deweloperzy mogą skorzystać z bardziej przyjaznego dla użytkownika narzędzia, aby usprawnić zbieranie danych w swoich badaniach. W ramach projektu można zaktualizować i ulepszyć dokumentację dotyczącą instalacji i konfiguracji LORIS oraz materiały dla użytkowników, które służą do szkolenia nowych użytkowników. Celem projektu będzie też pomoc w migracji i aktualizacji dokumentacji z LORIS GitHub wiki do czytania dokumentów. Tymczasem projekt może zawierać schemat bazy danych do komunikacji między danymi i ulepszenia wizualizacji architektury. W ramach tego projektu zaktualizujemy i ulepszimy treści przedstawiające LORIS, kontekst otwartej nauki i przypadki użycia.
IV. mocne strony w ramach projektu,
W ciągu ostatnich kilku lat uczestniczyłem(-am) w kilku projektach technicznych, dzięki którym mam duże doświadczenie w pisaniu tekstów technicznych. W szczególności odpowiadałem za pisanie dokumentacji w wielu wcześniejszych projektach zespołowych. Uważam, że mam wystarczające doświadczenie w korzystaniu z narzędzi do pisania technicznego, takich jak Read the Document, Sphinx, Mkdocs, Markdown, LaTeX itp. Tymczasem moje wcześniejsze doświadczenia w nauczaniu z dziedziny nauk przyrodniczych, techniki, inżynierii i matematyki pozwoliły mi również rozwinąć umiejętności w zakresie komunikacji technicznej. Dokumenty szkoleniowe LORIS dotyczące otwartych, powtarzalnych projektów z zakresu neuronauki z INCF byłyby dla mnie świetną okazją do zastosowania w LORIS technik pisania technicznego. Poza tym bardzo interesuję się neuroobrazowaniem i próbuję znaleźć możliwości zastosowania swojej wiedzy technicznej w tej dziedzinie. Dokumentacja szkoleniowa LORIS dotycząca otwartych, powtarzalnych projektów neuronauki w INCF byłaby dla mnie cennym doświadczeniem.
V. Wymagania
- Migracja i aktualizacja bieżącej dokumentacji LORIS
- Sprawdzanie, aktualizowanie i ulepszanie dokumentacji dotyczącej instalacji i konfiguracji LORIS oraz uzupełnianie brakujących materiałów dla użytkowników końcowych, które służą do szkolenia nowych użytkowników.
- pomagać w generowaniu diagramu bazy danych, aby przedstawiać relacje między danymi (np. temat, wizyta studyjna), i ulepszać wizualizację architektury;
- Pomoc w aktualizowaniu i ulepszaniu dokumentacji interfejsu LORIS API
- pomagać w aktualizowaniu i ulepszaniu treści przedstawiających LORIS, kontekst otwartej nauki i przypadki użycia, wykorzystując różne formaty mediów;
VI. Oś czasu
Współpraca społeczności (17 sierpnia – 13 września) a) Pełne zapoznanie się z oprogramowaniem LORIS i procesem pracy zespołu. b) Sprawdzenie, aktualizacja i ulepszenie dokumentacji instalacji/konfiguracji LORIS.
Tydzień 1 (14–20 września) Aktualizowanie i przenoszenie dokumentacji LORIS z wiki na GitHubie do Read the Docs.
Tydzień 2 (21–27 września) a) Przejrzyj aktualne materiały dla użytkowników dotyczące LORIS. b) Rozpoczęcie uzupełniania luk w materiałach LORIS dla użytkowników przez szkolenie dla nowych użytkowników w oparciu o bieżącą dokumentację.
Tydzień 3 (28 września–4 października) Uzupełnij luki w materiałach dla użytkowników LORIS, które służą do szkolenia nowych użytkowników.
Tydzień 4 (5–11 października) a) Poznaj obecną architekturę bazy danych LORIS. b) Zacznij wdrażać diagram bazy danych na platformie LORIS.
Tydzień 5 (12–18 października) a) Ukończ zadanie polegające na wygenerowaniu diagramu bazy danych LORIS. b) Przejrzyj obecny interfejs API LORIS i pomóż ulepszyć jego dokumentację.
Tydzień 6 (19–25 października) Kontynuuj prace nad ulepszeniem dokumentacji interfejsu LORIS API.
Tydzień 7 (26 października–1 listopada) Zakończenie ulepszania dokumentacji interfejsu LORIS API.
Tydzień 8 (2–8 listopada) Przejrzyj obecne treści, które przedstawiają LORIS, i zacznij aktualizować i ulepszać kontekst otwartej nauki.
Tydzień 9 (9–15 listopada) Zakończ aktualizacje i ulepszenia kontekstu nauki otwartej w treściach przedstawiających LORIS.
Tydzień 10 (16–22 listopada) Pomóż w aktualizowaniu i ulepszaniu części przypadków użycia w treściach przedstawiających LORIS.
Tydzień 11 (23–29 listopada) Dokończ aktualizowanie i ulepszanie wszystkich przypadków użycia w treściach prezentujących LORIS.
Finalizacja projektu (30 listopada – 5 grudnia) a) Wyczyść wszystkie utworzone przez siebie treści w dokumentacji. b) Połącz wszystkie utworzone przez siebie zgłoszenia pull request w GitHub i zamknij wszystkie utworzone przez siebie zgłoszenia. c) Ukończ ostateczny raport projektu i prześlij go do Google.
VII. Przyszłe zobowiązania
Po Google Season of Docs 2020 chciałbym kontynuować pracę nad dokumentacją LORIS. Chcę porozmawiać z deweloperami LORIS na temat możliwości dalszego aktualizowania i tworzenia dokumentacji dla nowych wersji. Chcę też poświęcić trochę czasu na sprawdzenie dokumentacji stworzonej podczas projektu Google Season of Docs, aby sprawdzić, czy nie ma w niej miejsca na ulepszenia. Na koniec, ponieważ mam odpowiednie wykształcenie inżynierskie, jestem otwarty na to, aby w przyszłości zająć się innymi aspektami oprogramowania LORIS, na przykład jego rozwojem.