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:
- OpenMRS
- Pisarz techniczny:
- Tęcza
- Nazwa projektu:
- Ulepszanie dokumentacji technicznej OpenMRS dla nowych deweloperów
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Uzasadnienie
W czasach, gdy świat zmaga się z konsekwencjami pandemii COVID-19, jeszcze wyraźniej widać, że system rejestrów medycznych typu open source, taki jak OpenMRS, może być częścią rozwiązania tego rodzaju kryzysu. Aby pomóc nowym deweloperom w poruszaniu się po ekosystemie OpenMRS, skróceniu procesu wdrażania i umożliwieniu większej liczbie nowych użytkowników szybkiego wkładu w rozwój OpenMRS, należy przygotować zwięzłą, przejrzystą i aktualną dokumentację. Istnieją 2 dokumenty dla nowych deweloperów: • Pierwsze kroki jako deweloper • Podręcznik dla deweloperów Jednak niektóre treści są nieaktualne, a format wymaga poprawy. Celem tego projektu jest zaktualizowanie treści i ulepszona formatacja tych 2 dokumentów, aby były bardziej przyjazne użytkownikom.
Zakres
- Zmień organizację i format zawartości tych dwóch dokumentów. Dokument Pierwsze kroki jako deweloper: a. Podziel 17 instrukcji na sekcje, z których każda zawiera mniej kroków, aby ułatwić użytkownikowi ich wykonywanie. b. Zmień kolejność etapów; niektóre z nich można łączyć. c. W tabelach podawaj linki do innych stron wiki, aby instrukcje były bardziej zwięzłe i czytelne.
Przewodnik dla deweloperów:a. Informacje ogólne dotyczące OpenMRS w pierwszych kilku rozdziałach mogą zostać skrócone, a użytkownicy mogą zostać przekierowani na stronę OpenMRS.org, aby uzyskać więcej informacji. b. Rozdział Konfiguracja powinien zostać przesunięty przed rozdziałem Proces rozwoju.
Zaktualizuj zawartość. W dokumentacji Pierwsze kroki jako deweloper:a. Aktualizacja konfiguracji środowiska na potrzeby Linuksa i Windowsa (prezentacja Dockera) Zaktualizuj konfigurację IDE w IntelliJ i Eclipse. Link do instrukcji dla deweloperów lub przewodnika dla deweloperów (w stosownych przypadkach). Upewnij się, że wszystkie treści, do których prowadzą linki, są aktualne.
Przewodnik dla deweloperów:a. Przedstaw proces programowania. b. Przedstaw, jak są zorganizowane zespoły programistów i jak ich członkowie współpracują ze sobą. Dodaj linki do spotkań i dyskusji zespołów. Pomóż nowym programistom znaleźć zespoły, do których chcieliby dołączyć. Dodaj Dockera w rozdziale konfiguracji systemu. d. Dodaj więcej szczegółów na temat różnych rodzajów modułów (moduł aplikacji referencyjnej, moduł OWA i moduł platformy) oraz sposobu ich współpracy. e. Dodaj proste przykładowe kody, aby pokazać, jak tworzyć i wdrażać poszczególne rodzaje modułów. f. Dodaj proste przykłady testów dla każdego rodzaju modułu.
Analiza odbiorców
Przewodnikiem dla programistów (Pierwsze kroki) i Podręcznika dla programistów jest skierowany do programistów, którzy nie mają żadnej wiedzy na temat OpenMRS lub mają niewielką wiedzę na ten temat. Istnieją 2 rodzaje programistów: Pierwszy typ odbiorców to juniorzy, którzy mają niewielkie doświadczenie w programowaniu lub nie mają go wcale. Mogą to być na przykład uczestnicy GSoC, którzy szukają projektów z prawdziwego świata, aby uczyć się tworzenia oprogramowania open source. Te 2 dokumenty powinny zawierać wystarczającą ilość informacji i odniesień, aby deweloperzy mogli uzupełnić luki w swojej wiedzy i w względnie krótkim czasie zacząć angażować się w projekty OpenMRS. Główne cele młodszych programistów to: 1. Poznanie umiejętności potrzebnych do korzystania z OpenMRS (MySQL, Java Spring. React.js czy Git) i znaleźć zasoby umożliwiające zdobycie tych 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. generować prosty kod do tworzenia nowych modułów; 7. Wdróż nowo utworzone moduły. 8. Testowanie modułów. 9. Używanie Git do tworzenia żądań pull. Drugim rodzajem odbiorców są średnio zaawansowani deweloperzy i doświadczeni deweloperzy, którzy chcą dostosowywać OpenMRS do potrzeb własnej organizacji lub wnosić wkład w OpenMRS. Doświadczeni programiści powinni zapoznać się z tymi 2 dokumentami, które zawierają omówienie OpenMRS i zawierają wskazówki pozwalające zapoznać się ze szczegółowymi informacjami na temat technologii w przewodniku dla programistów i innych materiałach. Główne cele dla doświadczonych programistów to: 1. Poznaj model danych i architekturę 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ź bardziej szczegółowe materiały.
Plan projektu
Faza planowania: • udoskonalaj cele określone w sekcji Zakres; • znajduj nieaktualne treści; • twórz zarysy obu dokumentów; • przedstawiaj zarys mentorowi i ekspertom w danym temacie; • aktualizuj plan projektu.
Faza tworzenia treści • Poznaj Dockera, przejdź przez wszystkie etapy instalacji i utwórz prosty przykładowy kod lub kod testowy • Przeprowadź wywiady z ekspertami w zakresie technologii • Opracuj pierwszy szkic 2 dokumentów
Sprawdzanie i publikowanie treści • Samodzielna edycja treści • Wysyłanie gotowych wersji roboczych do recenzentów (mentorów i SME) oraz użytkowników do opinii. • Poprawienie wersji roboczej. • Opublikuj oba dokumenty na stronie wiki OpenMRS. • Napisać raport z projektu
Zadania wstępne
Przeprowadziłem konfigurację środowiska programistycznego w systemie Linux i pakietu OpenMRS SDK. Jestem w trakcie konfigurowania IDE. Nadal będę pracować nad tworzeniem prostych modułów i pisaniem kodu testowego.
Odsyłacze 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.openmrs.org/t/looking-for-a-mentor-for-gsod2020-project-improving-documentation-for-new-developers/28999 https://talk.openmrs.org/t/a-possible-new-gsod-2020-project/28947