Projet OpenMRS

Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.

Résumé du projet

Organisation Open Source:
OpenMRS
Rédacteur technique:
Arc-en-ciel
Nom du projet:
Améliorer les documents techniques OpenMRS pour les nouveaux développeurs
Durée du projet:
Durée standard (3 mois)

Project description

Justification

Alors que le monde souffre des conséquences de la pandémie de COVID-19, il est encore plus évident qu'un système de dossiers médicaux Open Source comme OpenMRS peut faire partie de la solution à ce type de crise. Pour aider les nouveaux développeurs à naviguer dans l'écosystème OpenMRS, raccourcir leur processus d'intégration et permettre à davantage de nouveaux développeurs de contribuer rapidement au développement d'OpenMRS, il est nécessaire de disposer d'une documentation concise, claire et à jour. Il existe deux documents destinés aux nouveaux développeurs : • Premiers pas en tant que développeur • Manuel du développeur Toutefois, certains contenus sont obsolètes et le format doit être amélioré. L'objectif de ce projet est de mettre à jour le contenu et d'améliorer le format de ces deux documents afin de les rendre plus conviviaux.

Définition du champ d'application

  1. Réorganisez et reformatez le contenu de ces deux documents. Pour le document "Premiers pas en tant que développeur" : a. Divisez les 17 étapes de l'instruction en sections, chacune d'entre elles contenant moins d'étapes, afin que l'utilisateur puisse la suivre plus facilement. b. Réorganisez l'ordre des étapes. Certaines étapes peuvent être combinées. c. Listez les liens vers d'autres pages wiki dans des tableaux, afin que les instructions soient plus concises et lisibles.

Pour le manuel du développeur : a. Les informations générales d'OpenMRS dans les premiers chapitres peuvent être raccourcies. Les utilisateurs peuvent être redirigés vers la page OpenMRS.org pour en savoir plus. b. Le chapitre Configuration doit être déplacé avant le chapitre Processus de développement

  1. Mettez à jour le contenu. Pour le document "Premiers pas en tant que développeur" : a. Mettre à jour un environnement configuré pour Linux et Windows (introduire Docker) b. Mettez à jour la configuration IDE pour IntelliJ et Eclipse c. Lien vers le manuel ou le guide du développeur, le cas échéant. d. Assurez-vous que tous les liens vers son contenu sont à jour.

    Pour le manuel du développeur : a. Présentez le workflow de développement. b. Présenter la façon dont les équipes de développement sont organisées et la manière dont les membres de l'équipe travaillent ensemble ; ajouter des liens vers des réunions et des discussions d'équipe ; aider les nouveaux développeurs à trouver les équipes qu'ils pourraient vouloir rejoindre. c. Ajout de Docker au chapitre "Configuration du système". d. Ajoutez des informations supplémentaires sur les différents types de modules (module d'application de référence, module OWA et module de plate-forme), ainsi que sur la façon dont ils fonctionnent ensemble. e. Ajoutez des exemples de code simples pour montrer comment chaque type de module est créé et déployé. f. Ajoutez des exemples de test simples pour chaque type de module.

Analyse de l'audience

Le cours "Premiers pas en tant que développeur" et le manuel du développeur s'adressent aux développeurs qui ont peu ou pas de connaissances sur OpenMRS. Il peut y avoir deux types de développeurs : Le premier type d'audience est constitué de développeurs juniors ayant peu ou pas d'expérience en développement logiciel. Par exemple, les étudiants du GSoC, qui recherchent des projets concrets pour se familiariser avec le développement de logiciels Open Source. Pour ces développeurs, les deux documents doivent présenter suffisamment de détails et de références afin qu'ils puissent commencer à combler les lacunes en termes de connaissances et commencer à contribuer aux projets OpenMRS dans un laps de temps relativement court. Les principaux objectifs pour les développeurs juniors sont les suivants : 1. Comprendre les compétences nécessaires pour participer à OpenMRS (MySQL, Java Spring. (React.js, Git, etc.) et trouver les ressources qui vous permettront d'acquérir ces compétences. 2. Rejoignez la communauté OpenMRS et découvrez les outils de communication. 3. Configurer l'environnement et l'IDE 4. Installez le SDK OpenMRS. 5. Comprendre le workflow de développement 6. Produire du code simple pour créer des modules 7. Déployez les nouveaux modules. 8. Modules de test 9. Utilisez Git pour effectuer des demandes d'extraction. Le deuxième type d'audience est constitué des développeurs intermédiaires ou seniors qui souhaitent personnaliser OpenMRS en fonction des besoins de leur propre organisation ou pour contribuer à OpenMRS. Pour ces développeurs plus expérimentés, ces deux documents doivent offrir une vue d'ensemble d'OpenMRS et les orienter vers des informations plus détaillées sur les technologies, disponibles dans le guide du développeur et dans d'autres ressources. Les principaux objectifs pour les développeurs expérimentés sont les suivants : 1. Comprendre le modèle de données et l'architecture d'OpenMRS 2. Rejoignez la communauté OpenMRS et découvrez les outils de communication. 3. Trouvez des liens vers les dépôts de code OpenMRS. 4. Accédez à des ressources plus détaillées.

Plan du projet

  1. Phase de planification : • Affiner les objectifs définis dans la section "Portée" • Identifier les contenus obsolètes • Rédiger les grandes lignes des deux documents • Présenter les grandes lignes au mentor et aux experts du sujet • Mettre à jour le plan du projet

  2. Phase de développement du contenu • Apprendre Docker, suivre toutes les étapes d'installation et produire un exemple de code/code de test simple • Interroger des experts pour poser des questions • Développer la première version des deux documents

  3. Examen et publication du contenu • Modifiez vous-même le contenu • Envoyez les brouillons terminés aux réviseurs (mentors et experts) et aux utilisateurs finaux pour recueillir leurs commentaires • Révisez le brouillon • Publiez les deux documents sur la page wiki OpenMRS. • Rédiger un rapport de projet

Travail préliminaire

J'ai travaillé sur l'environnement de développement configuré dans le système Linux et sur la configuration du SDK OpenMRS. Je suis en train de configurer l'IDE. Je vais continuer à travailler sur la création de modules simples et l'écriture du code de test.

Références et discussions

https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502