Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- OpenMRS
- Escritor técnico:
- Arcoíris
- Nombre del proyecto:
- Mejora de la documentación técnica de OpenMRS para desarrolladores nuevos
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Justificación
A medida que el mundo sufre las consecuencias de la pandemia del COVID-19, es todavía más evidente que un sistema de historia clínica de código abierto, como OpenMRS, puede ser parte de la solución a este tipo de crisis. Para ayudar a los nuevos desarrolladores a navegar por el ecosistema de OpenMRS, acortar su proceso de incorporación y permitir que más nuevos usuarios contribuyan rápidamente al desarrollo de OpenMRS, es necesario tener documentación concisa, clara y actualizada. Hay dos documentos existentes para desarrolladores nuevos: • Cómo comenzar como desarrollador • Manual para desarrolladores Sin embargo, algunos de los contenidos están desactualizados y el formato debe mejorarse. El objetivo de este proyecto es actualizar el contenido y mejorar el formato de estos dos documentos para que sean más fáciles de usar.
Permiso
- Reorganiza y cambia el formato del contenido de estos dos documentos. En el documento Primeros pasos como desarrollador: a. Divide los 17 pasos de la instrucción en secciones. Cada una contendrá menos pasos, de modo que el usuario pueda seguirla con más facilidad. b. Reorganiza el orden de los pasos; algunos se pueden combinar. c. Enumera vínculos a otras páginas de Wiki en tablas, de modo que las instrucciones sean más concisas y legibles.
En el manual para desarrolladores: a. La información general de OpenMRS en los primeros capítulos puede acortarse. Se puede dirigir a los usuarios a la página de OpenMRS.org para que obtengan más detalles. b. El capítulo Configuración debe avanzar antes que el capítulo Proceso de desarrollo.
Actualiza el contenido. En el documento Primeros pasos como desarrollador: a. Actualizar la configuración del entorno para Linux y Windows (presentar Docker) b. Se actualizó la configuración del IDE para IntelliJ y Eclipse. Vínculo al manual para desarrolladores o a la guía para desarrolladores cuando corresponda. d. Asegúrate de que todos los contenidos del vínculo estén actualizados.
En el manual para desarrolladores: a. Presentar el flujo de trabajo de desarrollo b. Presenta cómo se organizan los equipos de desarrollo y cómo trabajan juntos los miembros; agrega vínculos a reuniones y debates de equipos; ayuda a los desarrolladores nuevos a encontrar los equipos a los que podrían querer unirse. c. Agregar Docker en el capítulo de configuración del sistema. d. Agrega más detalles sobre los diferentes tipos de módulos (módulo de aplicación de referencia, módulo OWA y módulo de plataforma), cómo funcionan juntos. e. Agregar códigos de ejemplo simples para mostrar cómo se compila y se implementa cada tipo de módulos Agrega ejemplos de prueba simples para cada tipo de módulo.
Análisis del público
El público objetivo de los Introducción al manual para desarrolladores y del manual para desarrolladores son desarrolladores que tienen poco o ningún conocimiento de OpenMRS. Puede haber dos tipos de desarrolladores: El primer tipo son los desarrolladores junior, con poca o ninguna experiencia en desarrollo de software. Por ejemplo, los estudiantes de la GSoC que buscan proyectos del mundo real para aprender sobre desarrollo de software de código abierto. Para estos desarrolladores, los dos documentos deben presentar suficientes detalles y referencias para que puedan comenzar a llenar las brechas de conocimiento y comenzar a contribuir a los proyectos de OpenMRS en un período relativamente corto. Los objetivos principales de los desarrolladores junior son los siguientes: 1. Comprender las habilidades necesarias para participar en OpenMRS (MySQL, Java Spring) React.js, Git, etc.) y encuentra los recursos para aprender estas habilidades. 2. Únete a la comunidad de OpenMRS y conoce las herramientas de comunicación. 3. Configurar el entorno y el IDE 4. Instala el SDK de OpenMRS. 5. Comprender el flujo de trabajo de desarrollo 6. Produce un código simple para crear módulos nuevos. 7. Implementar módulos creados recientemente 8. Módulos de prueba. 9. Usa Git para realizar solicitudes de extracción. El segundo tipo de público son los desarrolladores de nivel medio o sénior que buscan personalizar OpenMRS para satisfacer las necesidades de su organización o contribuir a OpenMRS. Para estos desarrolladores con más experiencia, los dos documentos deben proporcionar una descripción general de OpenMRS y servir como guía para dirigirlos a tecnologías más detalladas en la Guía para desarrolladores y otros recursos. Los objetivos principales de los desarrolladores experimentados son los siguientes: 1. Comprender el modelo de datos y la arquitectura de OpenMRS 2. Únete a la comunidad de OpenMRS y conoce las herramientas de comunicación. 3. Encuentra vínculos a repositorios de código de OpenMRS. 4. Encuentra recursos más detallados.
Planificación del proyecto
Fase de planificación: • Perfeccionar los objetivos establecidos en la sección Alcance • Identificar contenido desactualizado • Hacer esquemas para los dos documentos • Presentar el esquema al mentor y al experto en la materia • Actualizar el plan del proyecto
Fase de desarrollo de contenido: • Aprender sobre Docker, seguir todos los pasos de instalación y producir ejemplos simples de código/código de prueba • Entrevistar a SME para hacer preguntas • desarrollar el primer borrador de los dos documentos
Revisión y publicación de contenido • Edición del contenido por su cuenta • Envío de los borradores completados a revisores (mentores y SME) y usuarios finales para que brinden comentarios • Revisar el borrador • Publicar los dos documentos en la página de la wiki de OpenMRS • Escribir el informe del proyecto
Trabajo preliminar
Trabajé en la configuración del entorno de desarrollo en el sistema Linux y en la configuración del SDK de OpenMRS. Estoy en proceso de configurar el IDE. Seguiré trabajando en la compilación de módulos simples y en la escritura de código de prueba.
Referencias y debates
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://es-419-developer-project-for