Progetto OpenMRS

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:
OpenMRS
Technical writer:
Arcobaleno
Nome progetto:
Migliorare la documentazione tecnica di OpenMRS per i nuovi sviluppatori
Durata del progetto:
Durata standard (3 mesi)

Project description

Ragionamento

Mentre il mondo sta subendo le conseguenze della pandemia di COVID-19, è ancora più evidente che un sistema di cartelle cliniche open source come OpenMRS può essere parte della soluzione a questo tipo di crisi. Per aiutare i nuovi sviluppatori a muoversi nell'ecosistema OpenMRS, abbreviare il processo di onboarding e consentire a un maggior numero di nuovi arrivati di contribuire rapidamente allo sviluppo di OpenMRS, è necessario disporre di una documentazione concisa, chiara e aggiornata. Esistono due documenti esistenti per i nuovi sviluppatori: • Introduzione come sviluppatore • Manuale per gli sviluppatori Tuttavia, alcuni contenuti sono obsoleti e il formato deve essere migliorato. L'obiettivo di questo progetto è aggiornare i contenuti e migliorare il formato di questi due documenti per renderli più facili da usare.

Ambito

  1. Riorganizzare e riformattare i contenuti di questi due documenti. Per il documento Getting Started as a Developer: a. Dividi i 17 passaggi delle istruzioni in sezioni. Ogni sezione contiene meno passaggi, in modo che l'utente sia più facile da seguire. b. Riordina i passaggi; alcuni passaggi possono essere combinati. c. Elenca i link ad altre pagine wiki nelle tabelle, in modo che le istruzioni siano più concise e leggibili.

Per il Manuale per gli sviluppatori: a. Le informazioni di base su OpenMRS nei primi capitoli possono essere abbreviate. Gli utenti possono essere indirizzati alla pagina di OpenMRS.org per saperne di più. b. Il capitolo Impostazione deve essere spostato prima del capitolo Processo di sviluppo

  1. Aggiorna i contenuti. Per il documento Getting Started as a Developer: a. Aggiorna la configurazione dell'ambiente per Linux e Windows (introduci Docker) b. Aggiorna la configurazione IDE per IntelliJ ed Eclipse. Link al Manuale per gli sviluppatori o alla Guida per gli sviluppatori laddove applicabile. d. Assicurati che tutti i contenuti dei link siano aggiornati.

    Per il Manuale per gli sviluppatori: a. Introduci il flusso di lavoro per lo sviluppo. b. Illustra come sono organizzati i team di sviluppo, come collaborano i membri del team, aggiungi link alle riunioni del team e alle discussioni tra i team, aiuta i nuovi sviluppatori a trovare i team a cui potrebbero voler partecipare. c. Aggiungi Docker al capitolo sulla configurazione di sistema. d. Aggiungi ulteriori dettagli sui diversi tipi di moduli (modulo applicazione di riferimento, modulo OWA e modulo della piattaforma), come funzionano insieme. ad es. Aggiungi semplici codici di esempio per mostrare come viene creato e implementato ogni tipo di modulo. f. Aggiungi semplici esempi di test per ogni tipo di modulo.

Analisi del pubblico

Il pubblico di destinazione della Guida introduttiva come sviluppatore e del Manuale per gli sviluppatori è composto da sviluppatori che hanno poca o nessuna conoscenza di OpenMRS. Potrebbero esserci due tipi di sviluppatori: il primo tipo di pubblico è costituito dagli sviluppatori junior con poca o nessuna esperienza nello sviluppo software. Ad esempio, gli studenti GSoC, che cercano progetti reali per saperne di più sullo sviluppo di software open source. I due documenti devono presentare dettagli e riferimenti sufficienti a colmare le lacune nelle conoscenze e a contribuire ai progetti OpenMRS in un periodo di tempo relativamente breve. Gli obiettivi principali per gli sviluppatori junior sono: 1. Acquisisci le competenze necessarie per partecipare a OpenMRS (MySQL, Java Spring. React.js, Git ecc.) e trova le risorse per apprendere queste competenze. 2. Unisciti alla community OpenMRS e scopri gli strumenti di comunicazione. 3. Configura l'ambiente e l'IDE. 4. Installa l'SDK OpenMRS. 5. Comprendere il flusso di lavoro di sviluppo. 6. Produci un codice semplice per creare nuovi moduli. 7. Eseguire il deployment dei moduli appena creati. 8. Testa i moduli. 9. Utilizza Git per effettuare richieste di pull. Il secondo tipo di pubblico è costituito dagli sviluppatori di livello medio o senior che cercano di personalizzare OpenMRS per soddisfare le esigenze della propria organizzazione o per contribuire a OpenMRS. Per questi sviluppatori più esperti, i due documenti devono fornire una panoramica di OpenMRS e fungere da guida per indirizzare gli sviluppatori a dettagli più approfonditi sulle tecnologie nella Guida per gli sviluppatori e in altre risorse. Gli obiettivi principali per gli sviluppatori esperti sono: 1. Comprendere l'architettura e il modello dei dati di OpenMRS 2. Unisciti alla community OpenMRS e scopri gli strumenti di comunicazione. 3. Trova i link ai repository di codice OpenMRS. 4. Trova risorse più approfondite.

Piano del progetto

  1. Fase di pianificazione: • Perfezionare gli obiettivi definiti nella sezione Ambito • Identificare contenuti obsoleti • Realizzare degli schemi per i due documenti • Presentare lo schema al mentore e agli esperti in materia • Aggiornare il piano di progetto

  2. Fase di sviluppo dei contenuti • Impara a conoscere Docker, segui tutti i passaggi di installazione e produci un semplice codice di esempio/codice di test • Intervista gli SME per porre domande • Sviluppa la prima bozza dei due documenti

  3. Revisione e pubblicazione dei contenuti • Modifica autonomamente i contenuti • Invia le bozze completate ai revisori (mentori e PMI) e agli utenti finali per ricevere feedback • Rivedi la bozza • Pubblica i due documenti nella pagina wiki di OpenMRS. • Scrivere un report di progetto

Lavoro preliminare

Ho lavorato sulla configurazione dell'ambiente di sviluppo nel sistema Linux e nella configurazione dell'SDK OpenMRS. Sto configurando l'IDE. Continuerò a lavorare alla creazione di moduli semplici e alla scrittura di codice di test.

Riferimenti e discussioni

https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy-for-new-developer-learner/18861/14 https://talk.openmor-gs-project-family-looking2