Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- OpenMRS
- Rédacteur technique:
- Arc-en-ciel
- Nom du projet:
- Amélioration de la documentation technique OpenMRS pour les nouveaux développeurs
- Durée du projet:
- Durée standard (trois mois)
Project description
Justification
Alors que le monde subit les 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 pour 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 participants de contribuer rapidement au développement d'OpenMRS, il est nécessaire de disposer de documentations concises, claires et à jour. Deux documents sont disponibles pour les nouveaux développeurs : • Premiers pas en tant que développeur • Manuel du développeur Cependant, 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 pour les rendre plus conviviaux.
Portée
- 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 contenant moins d'étapes, afin que l'utilisateur puisse les suivre plus facilement. b. Réorganisez l'ordre des étapes. Certaines 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 sur OpenMRS figurant dans les premiers chapitres peuvent être raccourcies. Les utilisateurs peuvent être dirigés vers la page OpenMRS.org pour en savoir plus. b. Le chapitre "Configuration" doit être placé avant le chapitre "Processus de développement".
Mettez à jour le contenu. Pour le document "Premiers pas en tant que développeur" : a. Mise à jour de l'environnement configuré pour Linux et Windows (présentation de Docker) b. Mettre à jour la configuration de l'IDE pour IntelliJ et Eclipse Lien vers le manuel du développeur ou le guide du développeur, le cas échéant. d. Assurez-vous que tous les contenus auxquels vous faites référence sont à jour.
Pour le manuel du développeur : a. Présentez le workflow de développement. b. Présenter la manière dont les équipes de développement sont organisées, comment les membres de l'équipe travaillent ensemble ; ajouter des liens vers les réunions et les discussions d'équipe ; aider les nouveaux développeurs à trouver les équipes qu'ils voudront peut-être rejoindre. c. Ajoutez Docker dans le chapitre "Configuration du système". d. Ajoutez plus de détails sur les différents types de modules (module d'application de référence, module OWA et module de plate-forme), et sur leur fonctionnement. Ajoutez des exemples de code simples pour montrer comment chaque type de module est compilé et déployé. f. Ajoutez des exemples de test simples pour chaque type de module.
Analyse des audiences
Le manuel de démarrage en tant que développeur et le manuel du développeur sont destinés aux développeurs qui ont peu ou pas de connaissances sur OpenMRS. Il peut y avoir deux types de développeurs : le premier 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 en savoir plus sur le développement de logiciels Open Source. Pour ces développeurs, les deux documents doivent contenir suffisamment de détails et de références pour pouvoir commencer à combler les lacunes en termes de connaissances et à contribuer aux projets OpenMRS dans un délai relativement court. Les principaux objectifs des développeurs juniors sont les suivants : 1. Comprendre les compétences nécessaires pour participer à OpenMRS (MySQL, Java Spring) (React.js, Git, etc.) et trouvez les ressources nécessaires pour les apprendre. 2. Rejoignez la communauté OpenMRS et découvrez les outils de communication. 3. Configurez l'environnement et l'IDE. 4. Installez le SDK OpenMRS. 5. Comprendre le workflow de développement 6. Créez du code simple pour créer des modules. 7. Déployez les modules nouvellement créés. 8. Tester des modules 9. Utilisez Git pour envoyer des demandes d'extraction. Le deuxième type d'audience est constitué de développeurs intermédiaires ou expérimentés qui souhaitent personnaliser OpenMRS en fonction des besoins de leur propre organisation ou contribuer à OpenMRS. Pour ces développeurs plus expérimentés, les deux documents doivent fournir une présentation d'OpenMRS et servir de guide pour les diriger vers des informations plus détaillées sur les technologies dans le guide du développeur et d'autres ressources. Les principaux objectifs des 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. Découvrez d'autres ressources plus détaillées.
Plan du projet
Phase de planification : • affiner les objectifs définis dans la section "Champ d'application" ; • identifier les contenus obsolètes ; • élaborer des plans pour les deux documents ; • présenter le plan au mentor et aux experts ; • mettre à jour le plan du projet
Phase de développement du contenu • Apprenez à utiliser Docker, suivez toutes les étapes d'installation et générez un exemple de code ou de code de test simple. • Interrogez des experts pour poser des questions • Développer la première ébauche des deux documents
Examen et publication du contenu • Révisez le contenu vous-même • Envoyez les brouillons terminés aux réviseurs (mentor et experts) et aux utilisateurs finaux pour obtenir des commentaires • Révisez le brouillon • Publiez les deux documents sur la page Wiki d'OpenMRS. • Rédiger un rapport de projet
Travaux préliminaires
J'ai effectué quelques travaux sur la configuration de l'environnement de développement dans le système Linux et la configuration du SDK OpenMRS. Je suis en train de configurer l'IDE. Je vais continuer à créer des modules simples et à écrire du code de test.
Références et discussions
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