Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- OpenMRS
- Technical Writer:
- Arcobaleno
- Nome del progetto:
- Miglioramento della documentazione tecnica di OpenMRS per i nuovi sviluppatori
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Motivazione
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ò far parte della soluzione per questo tipo di crisi. Per aiutare i nuovi sviluppatori a navigare nell'ecosistema OpenMRS, abbreviare la procedura 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 già due documenti per i nuovi sviluppatori: • Guida introduttiva per gli sviluppatori • Manuale dello sviluppatore 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
- Riorganizza e riformatta i contenuti di questi due documenti. Per il documento "Primi passi come sviluppatore": a. Dividi i 17 passaggi dell'istruzione in sezioni, ciascuna con un numero inferiore di passaggi, in modo che l'utente possa seguirli più facilmente. b. Riordina l'ordine dei passaggi; alcuni passaggi possono essere combinati. c. Elenca i link ad altre pagine wiki all'interno di tabelle, in modo che le istruzioni siano più concise e leggibili.
Per il Manuale dello sviluppatore: a. Le informazioni di base su OpenMRS nei primi capitoli possono essere abbreviate e gli utenti possono essere indirizzati alla pagina OpenMRS.org per scoprire ulteriori dettagli. b. Il capitolo Configurazione deve essere spostato prima del capitolo Processo di sviluppo
Aggiorna i contenuti. Per il documento Getting Started as a Developer: a. Aggiorna la configurazione dell'ambiente per Linux e Windows (introduzione di Docker) b. Aggiorna la configurazione dell'IDE per IntelliJ e Eclipse. Link al Manuale dello sviluppatore o alla Guida per gli sviluppatori, ove applicabile. d. Assicurati che tutti i contenuti a cui rimandi siano aggiornati.
Per il Manuale per gli sviluppatori: a. Presenta il flusso di lavoro per lo sviluppo. b. Spiega come sono organizzati i team di sviluppo e come i membri del team lavorano insieme; aggiungi link alle riunioni di gruppo e alle discussioni di gruppo; aiuta i nuovi sviluppatori a trovare i team a cui potrebbero voler partecipare. c. Aggiungi Docker nel capitolo sulla configurazione del sistema. d. Aggiungi ulteriori dettagli sui diversi tipi di moduli (modulo dell'applicazione di riferimento, modulo OWA e modulo della piattaforma) e sul loro funzionamento. e. Aggiungi semplici codici di esempio per mostrare come vengono creati e implementati ogni tipo di moduli. f. Aggiungi semplici esempi di test per ogni tipo di modulo.
Analisi dei segmenti di pubblico
I destinatari della Guida introduttiva come sviluppatore e del Manuale per gli sviluppatori sono sviluppatori con una conoscenza scarsa o nulla di OpenMRS. Potrebbero esserci due tipi di sviluppatori: Il primo tipo di pubblico è costituito da sviluppatori junior con poca o nessuna esperienza di sviluppo software. Ad esempio, gli studenti del GSoC, che cercano progetti reali per imparare a sviluppare software open source. Per questi sviluppatori, i due documenti devono presentare dettagli e riferimenti sufficienti per iniziare a colmare le lacune di conoscenza e iniziare a contribuire ai progetti OpenMRS in un periodo di tempo relativamente breve. Gli obiettivi principali per gli sviluppatori junior sono: 1. Conoscere le competenze necessarie per partecipare a OpenMRS (MySQL, Java Spring. React.js, Git e così via) e trova le risorse per acquisire queste competenze. 2. Unisciti alla community di OpenMRS, scopri gli strumenti di comunicazione. 3. Configura l'ambiente e l'IDE. 4. Installa l'SDK OpenMRS. 5. Comprendi il flusso di lavoro di sviluppo. 6. Genera codice semplice per creare nuovi moduli. 7. Esegui il deployment dei moduli appena creati. 8. Testare i moduli. 9. Utilizza Git per effettuare richieste pull. Il secondo tipo di pubblico è costituito da sviluppatori di livello intermedio o sviluppatori senior che vogliono personalizzare OpenMRS in base alle esigenze della propria organizzazione o contribuire a OpenMRS. Per questi sviluppatori più esperti, i due documenti dovrebbero fornire una panoramica di OpenMRS e fungere da guida per indirizzarli a dettagli più approfonditi sulle tecnologie nella Guida per gli sviluppatori e in altre risorse. Gli obiettivi principali per gli sviluppatori esperti sono: 1. Comprendi il modello di dati e l'architettura di OpenMRS 2. Unisciti alla community di OpenMRS, scopri gli strumenti di comunicazione. 3. Trova i link ai repository di codice OpenMRS. 4. Trova risorse più approfondite.
Progetto
Fase di pianificazione: • Perfeziona gli obiettivi impostati nella sezione Ambito • Identifica contenuti obsoleti • Produci schemi per i due documenti • Presenta lo schema al tutor ed esperti della materia (SME) • Aggiorna il piano di progetto
Fase di sviluppo dei contenuti • Scopri Docker, segui tutti i passaggi di installazione e produci codice di esempio/codice di test semplice • Intervista le PME per porre domande • Sviluppare la prima bozza dei due documenti
Revisione e pubblicazione dei contenuti • Modifica autonoma dei contenuti • Invia le bozze completate ai revisori (mentor e SME) e agli utenti finali per ricevere feedback • Rivedi la bozza • Pubblica i due documenti nella pagina della wiki di OpenMRS. • Scrivi una relazione sul progetto
Lavori preliminari
Ho svolto alcuni lavori sulla configurazione dell'ambiente di sviluppo nel sistema Linux e sull'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 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