En esta página, se incluyen 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
- Redactor técnico:
- Rainbow
- 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
Razones
A medida que el mundo sufre las consecuencias de la pandemia del COVID-19, es aún más evidente que un sistema de registros médicos de código abierto como OpenMRS puede ser parte de la solución para este tipo de crisis. Para ayudar a los desarrolladores nuevos a navegar por el ecosistema de OpenMRS, acortar su proceso de integración y permitir que más recién llegados puedan contribuir rápidamente al desarrollo de OpenMRS, es necesario tener documentación concisa, clara y actualizada. Hay dos documentos existentes para desarrolladores nuevos: • Primeros pasos 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.
Alcance
- Vuelve a organizar y a dar formato al contenido de estos dos documentos. En el documento Primeros pasos para desarrolladores, haz lo siguiente: a. Divide los 17 pasos de la instrucción en secciones, cada una con menos pasos, para que el usuario pueda seguirlos con mayor facilidad. b. Reorganiza el orden de los pasos. Algunos pasos se pueden combinar. c. Incluye vínculos a otras páginas de la wiki en tablas para que las instrucciones sean más concisas y legibles.
Para el Manual para desarrolladores: a. La información de referencia de OpenMRS en los primeros capítulos se puede acortar, y se puede dirigir a los usuarios a la página OpenMRS.org para obtener 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 para desarrolladores, haz lo siguiente: a. Actualizar la configuración del entorno para Linux y Windows (Presenta Docker) b. Actualizar la configuración del IDE para IntelliJ y Eclipse c. Vínculo al Manual para desarrolladores o a la Guía para desarrolladores cuando corresponda. d. Asegúrate de que todo el contenido de vinculación esté actualizado.
Para el Manual para desarrolladores: a. Presenta el flujo de trabajo de desarrollo. b. Presenta cómo se organizan los equipos de desarrollo y cómo trabajan juntos los miembros del equipo. Agrega vínculos a las reuniones y discusiones del equipo. Ayuda a los desarrolladores nuevos a encontrar los equipos a los que podrían unirse. c. Agregar Docker al 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 de OWA y módulo de plataforma) y cómo funcionan en conjunto. e. Agrega códigos de ejemplo simples para mostrar cómo se compilan y se implementan cada tipo de módulos. f. Agrega ejemplos de pruebas simples para cada tipo de módulo.
Análisis de público
El público objetivo de Cómo comenzar como desarrollador y el Manual para desarrolladores son desarrolladores que tienen poco o ningún conocimiento de OpenMRS. Podría haber dos tipos de desarrolladores: El primer tipo de público son los desarrolladores junior con poca o ninguna experiencia en el desarrollo de software. Por ejemplo, los estudiantes de 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 los vacíos de conocimiento y comenzar a contribuir a los proyectos OpenMRS en un período de tiempo relativamente corto. Los principales objetivos 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 aprende a usar las herramientas de comunicación. 3. Configura el entorno y el IDE. 4. Instala el SDK de OpenMRS. 5. Comprende el flujo de trabajo de desarrollo. 6. Produce código simple para crear módulos nuevos. 7. Implementa los módulos recién creados. 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 intermedio o sénior que buscan personalizar OpenMRS para satisfacer las necesidades de su propia organización o para contribuir a OpenMRS. Para estos desarrolladores más experimentados, los dos documentos deben proporcionar una descripción general de OpenMRS y servir como guía para que puedan acceder a información más detallada sobre tecnologías en la Guía para desarrolladores y en 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 aprende sobre las herramientas de comunicación. 3. Busca 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 contenidos desactualizados • Crear esquemas para los dos documentos • Presentar el esquema al mentor y a los expertos en la materia (SME) • Actualizar el plan del proyecto
Fase de desarrollo de contenido • Aprende a usar Docker, sigue todos los pasos de instalación y produce un código de ejemplo o de prueba simple • Entrevista a los SMEs para hacerles preguntas • Desarrolla el primer borrador de los dos documentos
Revisión y publicación del contenido • Edita el contenido por tu cuenta • Envía los borradores completos a los revisores (mentor y SMEs) y a los usuarios finales para obtener comentarios • Revisa el borrador • Publica los dos documentos en la página de wiki de OpenMRS. • Redactar el informe del proyecto
Trabajo preliminar
Hice algunos trabajos en la configuración del entorno de desarrollo en el sistema Linux y en la configuración del SDK de OpenMRS. Estoy configurando 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 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