Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- OpenMRS
- Pisarz techniczny:
- Tęcza
- Nazwa projektu:
- Udoskonalanie dokumentacji technicznej OpenMRS dla nowych deweloperów
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Uzasadnienie
Konsekwencje pandemii COVID-19 na całym świecie są teraz jeszcze bardziej oczywiste, że system dokumentacji medycznej typu open source, np. OpenMRS, może pomóc w rozwiązaniu tego rodzaju kryzysu. Aby pomóc nowym deweloperom w poruszaniu się po ekosystemie OpenMRS, skrócić proces wdrażania i umożliwić większej liczbie osób, które mogą szybko uczestniczyć w rozwoju OpenMRS, potrzebna jest zwięzła, przejrzysta i aktualna dokumentacja. Istnieją dwa dokumenty dla nowych deweloperów: • pierwsze kroki jako programista; • instrukcja dla programistów. Niektóre treści są jednak nieaktualne i format wymaga poprawy. Celem tego projektu jest zaktualizowanie treści i ulepszenie formatu tych dwóch dokumentów, aby były bardziej przyjazne dla użytkownika.
Zakres
- Zmień kolejność i format zawartości tych 2 dokumentów. Dokument „Pierwsze kroki jako programista”: a. Podziel 17 kroków z tej instrukcji na sekcje. Każda z nich zawiera mniej kroków, aby użytkownik mógł łatwiej je wykonać. b. Zmień kolejność etapów (niektóre kroki można połączyć ze sobą). c. W tabelach umieść linki do innych stron wiki, aby instrukcje były bardziej zwięzłe i czytelne.
W przypadku instrukcji dla programistów: a. Podstawowe informacje na temat OpenMRS dostępne w kilku pierwszych rozdziałach można skrócić, a użytkowników można przekierować na stronę OpenMRS.org w celu uzyskania dodatkowych informacji. b. Rozdział o konfiguracji należy przenieść do większej części procesu programowania.
Zaktualizuj treść. W dokumencie „Pierwsze kroki jako programista”: a. Aktualizowanie środowiska skonfigurowanego dla systemów Linux i Windows (przedstawienie Dockera) b. Zaktualizuj konfigurację IDE dla IntelliJ i Eclipsec. Link do instrukcji dla programistów lub Przewodnika dla programistów (w stosownych przypadkach). d. Upewnij się, że wszystkie treści linków do podstron są aktualne.
W przypadku instrukcji dla programistów: a. Przedstaw proces programowania. b. Przedstaw strukturę zorganizowanych zespołów programistycznych i współpracę między członkami zespołu. Dodaj linki do spotkań zespołu, dyskusji zespołowych; pomóż nowym programistom znaleźć zespoły, do których mogą dołączyć. c. Dodaj Dockera w rozdziale konfiguracji systemu. d. Dodaj więcej informacji o różnych typach modułów (modułach aplikacji, modułach OWA i platformach) oraz o ich współdziałaniu. e. Dodaj proste przykładowe kody, aby pokazać, jak budowane i wdrażane są poszczególne rodzaje modułów. f. Dodaj proste przykłady testowe dla każdego modułu.
Analiza odbiorców
Docelowi odbiorcy Przewodnika dla programistów oraz Przewodnika dla programistów to twórcy, którzy mają niewielką wiedzę o OpenMRS lub nie mają jej wcale. Mogą być dwa rodzaje programistów: Pierwsza grupa to młodzi programiści z niewielkim doświadczeniem w programowaniu lub bez niego. Są to na przykład studenci GSoC, którzy szukają rzeczywistych projektów do nauki o tworzeniu oprogramowania open source. W przypadku tych deweloperów oba dokumenty powinny zawierać wystarczającą ilość szczegółów i materiałów referencyjnych, aby mogli oni zacząć wypełniać luki w wiedzy i w krótkim czasie przystąpić do tworzenia projektów OpenMRS. Główne cele młodszych deweloperów to: 1. Zdobycie umiejętności niezbędnych, aby uczestniczyć w programie OpenMRS (MySQL, Java Spring). React.js, Git itp.) i znajdź odpowiednie materiały, aby zdobyć te umiejętności. 2. Dołącz do społeczności OpenMRS i poznaj narzędzia do komunikacji. 3. Skonfiguruj środowisko i IDE. 4. Zainstaluj pakiet OpenMRS SDK. 5. Poznaj proces programowania. 6. Aby utworzyć nowe moduły, użyj prostego kodu. 7. Wdróż nowo utworzone moduły. 8. Moduły testowe. 9. Używaj Gita do wysyłania żądań pull. Drugim rodzajem odbiorców są deweloperzy na średnim poziomie i doświadczeni programiści, którzy chcą dostosować OpenMRS do potrzeb swojej organizacji lub wnieść swój wkład w jej rozwój. Dla bardziej doświadczonych programistów te dwa dokumenty powinny zawierać omówienie OpenMRS i powinien kierować ich do bardziej szczegółowych informacji na temat technologii zawartych w przewodniku dla programistów i innych zasobach. Najważniejsze cele doświadczonych programistów: 1. Zapoznanie się z modelem i architekturą danych OpenMRS. 2. Dołącz do społeczności OpenMRS i poznaj narzędzia do komunikacji. 3. Znajdź linki do repozytoriów kodu OpenMRS. 4. Znajdź więcej szczegółowych materiałów.
Plan projektu
Etap planowania: • Doprecyzowanie celów określonych w sekcji Zakres • Identyfikacja nieaktualnych treści • Opracowanie konspektów obu dokumentów • Przedstawienie konspektu mentora i MŚP • Aktualizacja planu projektu
Etap tworzenia treści • Opanowanie Dockera, opanowanie wszystkich kroków instalacji i tworzenie prostego przykładowego kodu/kodu testowego • Rozmowy z specjalistami w celu zadawania pytań • Opracowanie pierwszej wersji roboczej dwóch dokumentów
Sprawdzanie i publikowanie treści • Samodzielne edytowanie treści • Wysyłanie gotowych wersji roboczych do weryfikatorów (mentorów i specjalistów) oraz użytkowników do opinii. • Poprawianie wersji roboczej • Opublikuj oba dokumenty na stronie wiki OpenMRS. • Napisz raport z projektu.
Praca wstępna
Udało mi się trochę popracować nad środowiskiem programistycznym w systemie Linux i w konfiguracji pakietu OpenMRS. Jestem w trakcie konfigurowania IDE. Będę dalej pracować nad tworzeniem prostych modułów i pisaniem kodu testowego.
Źródła wiedzy i dyskusje
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy-for-new-developer-learner/18861/14 https://talk.openmorg.org/t/talk.openmrs.org/t/talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502