Diese Seite wurde von der Cloud Translation API übersetzt.

OpenMRS-Projekt

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:: OpenMRS
Technischer Redakteur:: Regenbogen
Projektname:: Verbesserung der technischen Dokumentation zu OpenMRS für neue Entwickler
Projektdauer:: Standardlaufzeit (3 Monate)

Projektbeschreibung

Begründung

Angesichts der Folgen der COVID-19-Pandemie wird immer deutlicher, dass ein Open-Source-System für Patientenakten wie OpenMRS Teil der Lösung für diese Art von Krise sein kann. Um neuen Entwicklern den Einstieg in das OpenMRS-System zu erleichtern, den Onboarding-Prozess zu verkürzen und mehr Neulingen zu ermöglichen, schnell zur Entwicklung von OpenMRS beizutragen, sind prägnante, klare und aktuelle Dokumentationen erforderlich. Für neue Entwickler gibt es bereits zwei Dokumente: • Erste Schritte als Entwickler • Entwicklerhandbuch Einige Inhalte sind jedoch veraltet und das Format muss verbessert werden. Ziel dieses Projekts ist es, die Inhalte zu aktualisieren und das Format dieser beiden Dokumente zu verbessern, damit sie nutzerfreundlicher werden.

Umfang

Ordnen Sie den Inhalt dieser beiden Dokumente neu an und formatieren Sie ihn neu. Für das Dokument „Erste Schritte als Entwickler“: a. Teilen Sie die 17 Schritte der Anleitung in Abschnitte auf. Jeder Abschnitt umfasst weniger Schritte, damit die Nutzenden sie leichter ausführen können. b. Ordnen Sie die Schritte neu an. Einige Schritte können kombiniert werden. c. Listen Sie Links zu anderen Wiki-Seiten in Tabellen auf, damit die Anleitung prägnanter und besser lesbar ist.

Für das Entwicklerhandbuch: a. Die OpenMRS-Hintergrundinformationen in den ersten Kapiteln können gekürzt werden. Nutzer können auf die OpenMRS.org-Seite weitergeleitet werden, um weitere Informationen zu erhalten. b. Das Kapitel „Einrichtung“ sollte vor dem Kapitel „Entwicklungsprozess“ verschoben werden.

Aktualisieren Sie den Inhalt. Für das Dokument „Erste Schritte als Entwickler“: a. Aktualisieren der Umgebungseinrichtung für Linux und Windows (Einführung in Docker) b. IDE-Konfiguration für IntelliJ und Eclipse aktualisieren c. Link zum Entwicklerhandbuch oder Entwicklerleitfaden, sofern zutreffend. d. Achten Sie darauf, dass alle Link-Inhalte aktuell sind.

Für das Entwicklerhandbuch: a. Stellen Sie den Entwicklungsablauf vor. b. Erläutern Sie, wie Entwicklungsteams organisiert sind und wie Teammitglieder zusammenarbeiten. Fügen Sie Links zu Teambesprechungen und Teamdiskussionen hinzu. Helfen Sie neuen Entwicklern, die Teams zu finden, denen sie beitreten möchten. c. Fügen Sie Docker in das Kapitel zur Systemeinrichtung ein. d. Fügen Sie weitere Details zu den verschiedenen Arten von Modulen (Referenzanwendungsmodul, OWA-Modul und Plattformmodul) und ihrer Funktionsweise hinzu. Fügen Sie einfache Beispielcodes hinzu, um zu zeigen, wie die einzelnen Arten von Modulen erstellt und bereitgestellt werden. Fügen Sie für jede Art von Modul einfache Testbeispiele hinzu.

Zielgruppenanalyse

Die Zielgruppe des Leitfadens „Erste Schritte als Entwickler“ und des Entwicklerhandbuchs sind Entwickler, die nur wenig oder gar keine Kenntnisse zu OpenMRS haben. Es kann zwei Arten von Entwicklern geben: Die erste Art von Zielgruppe sind Junior-Entwickler mit wenig oder keiner Erfahrung in der Softwareentwicklung. Beispielsweise GSoC-Teilnehmer, die nach realen Projekten suchen, um mehr über die Entwicklung von Open-Source-Software zu erfahren. Für diese Entwickler sollten die beiden Dokumente genügend Details und Verweise enthalten, damit sie ihre Wissenslücken schließen und in relativ kurzer Zeit zu den OpenMRS-Projekten beitragen können. Die wichtigsten Ziele für Junior-Entwickler sind: 1. Kenntnisse über die erforderlichen Fähigkeiten für die Teilnahme an OpenMRS (MySQL, Java Spring) React.js, Git usw.) und suchen Sie nach den Ressourcen, mit denen Sie diese Fähigkeiten erlernen können. 2. Treten Sie der OpenMRS-Community bei und lernen Sie die Kommunikationstools kennen. 3. Richten Sie die Umgebung und die IDE ein. 4. Installieren Sie das OpenMRS SDK. 5. Informationen zum Entwicklungsablauf 6. Erstellen Sie mit einfachem Code neue Module. 7. Stellen Sie neu erstellte Module bereit. 8. Testmodule 9. Git für Pull-Anfragen verwenden Die zweite Zielgruppe sind Entwickler mit mittlerer oder höherer Erfahrung, die OpenMRS an die Anforderungen ihrer eigenen Organisation anpassen oder zu OpenMRS beitragen möchten. Für diese erfahreneren Entwickler sollten die beiden Dokumente einen Überblick über OpenMRS bieten und als Leitfaden dienen, um sie zu detaillierteren Technologiedetails im Entwicklerhandbuch und in anderen Ressourcen zu leiten. Die wichtigsten Ziele für erfahrene Entwickler sind: 1. Datenmodell und Architektur von OpenMRS kennen Treten Sie der OpenMRS-Community bei und lernen Sie die Kommunikationstools kennen. 3. Links zu OpenMRS-Code-Repositories finden 4. Hier finden Sie detaillierte Ressourcen.

Projektplan

Planungsphase: • Die im Abschnitt „Umfang“ festgelegten Ziele verfeinern • Veraltete Inhalte identifizieren • Gliederungen für die beiden Dokumente erstellen • Die Gliederung dem Mentor und den Fachleuten präsentieren • Projektplan aktualisieren
Phase der Inhaltserstellung • Docker kennenlernen, alle Installationsschritte durchgehen und einfachen Beispiel-/Testcode erstellen • Fachleute interviewen und Fragen stellen • Ersten Entwurf der beiden Dokumente erstellen
Inhaltsüberprüfung und ‑veröffentlichung • Inhalte selbst bearbeiten • Die fertigen Entwürfe an Prüfer (Mentor und SME) und Endnutzer zur Rückmeldung senden • Den Entwurf überarbeiten • Die beiden Dokumente auf der OpenMRS-Wiki-Seite veröffentlichen. • Projektbericht schreiben

Vorarbeiten

Ich habe einige Arbeiten zur Einrichtung der Entwicklungsumgebung in einem Linux-System und zur Einrichtung des OpenMRS-SDK ausgeführt. Ich konfiguriere die IDE. Ich werde weiterhin an der Erstellung einfacher Module und dem Schreiben von Testcode arbeiten.

Referenzen und Diskussionen

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