Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- OpenMRS
- Redator técnico:
- Arco-íris
- Nome do projeto:
- Como melhorar a documentação técnica do OpenMRS para novos desenvolvedores
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Justificativa
Como o mundo está sofrendo as consequências da pandemia de COVID-19, fica ainda mais evidente que um sistema de prontuários médicos de código aberto, como o OpenMRS, pode fazer parte da solução para esse tipo de crise. Para ajudar os novos desenvolvedores a navegar pelo ecossistema do OpenMRS, encurtar o processo de integração e permitir que mais recém-chegados contribuam rapidamente para o desenvolvimento do OpenMRS, é necessário ter documentações concisas, claras e atualizadas. Há dois documentos para novos desenvolvedores: • Introdução para desenvolvedores • Manual do desenvolvedor No entanto, parte do conteúdo está desatualizado e o formato precisa de melhorias. O objetivo deste projeto é atualizar o conteúdo e melhorar o formato desses dois documentos para torná-los mais fáceis de usar.
Escopo
- Reorganize e reformule o conteúdo desses dois documentos. Para o documento "Primeiros passos como desenvolvedor": a. Divida as 17 etapas da instrução em seções, cada uma com menos etapas, para que seja mais fácil para o usuário seguir. b. Reorganize a ordem das etapas. Algumas delas podem ser combinadas. c. Liste links para outras páginas da wiki em tabelas para que as instruções fiquem mais concisas e legíveis.
Para o manual do desenvolvedor: a. As informações básicas do OpenMRS nos primeiros capítulos podem ser encurtadas; os usuários podem ser direcionados para a página do OpenMRS.org para obter mais detalhes. b. O capítulo "Configuração" precisa ser movido para antes do capítulo "Processo de desenvolvimento".
Atualize o conteúdo. Para o documento "Como começar a ser um desenvolvedor": Atualizar a configuração do ambiente para Linux e Windows (introdução ao Docker) b. Atualização da configuração do ambiente de desenvolvimento integrado para IntelliJ e Eclipse c. Link para o manual do desenvolvedor ou o guia do desenvolvedor, quando aplicável. d. Confira se todo o conteúdo vinculado está atualizado.
Para o Manual do desenvolvedor: a. Apresente o fluxo de trabalho de desenvolvimento. b. Apresentar como as equipes de desenvolvimento são organizadas, como os membros da equipe trabalham juntos, adicionar links para reuniões e discussões de equipe, ajudar novos desenvolvedores a encontrar as equipes das quais eles podem querer participar. c. Adicionar o Docker no capítulo de configuração do sistema. d. Adicionar mais detalhes sobre os diferentes tipos de módulos (módulo de aplicativo de referência, módulo OWA e módulo de plataforma) e como eles funcionam juntos. Por exemplo: Adicione exemplos de códigos simples para mostrar como cada tipo de módulo é criado e implantado. f. Adicione exemplos de testes simples para cada tipo de módulo.
Análise de público
O público-alvo do guia "Primeiros passos como desenvolvedor" e do manual do desenvolvedor são desenvolvedores com pouco ou nenhum conhecimento sobre o OpenMRS. Pode haver dois tipos de desenvolvedores: O primeiro tipo de público-alvo é de desenvolvedores juniores com pouca ou nenhuma experiência em desenvolvimento de software. Por exemplo, estudantes do GSoC, que procuram projetos reais para aprender sobre o desenvolvimento de software de código aberto. Para esses desenvolvedores, os dois documentos devem apresentar detalhes e referências suficientes para que eles possam começar a preencher as lacunas de conhecimento e começar a contribuir com os projetos do OpenMRS em um período relativamente curto. Os principais objetivos dos desenvolvedores juniores são: 1. Entenda as habilidades necessárias para participar do OpenMRS (MySQL, Java Spring. React.js, Git etc.) e encontre os recursos para aprender essas habilidades. 2. Participe da comunidade do OpenMRS e aprenda as ferramentas de comunicação. 3. Configurar o ambiente e o ambiente de desenvolvimento integrado. 4. Instale o SDK do OpenMRS. 5. Entenda o fluxo de trabalho de desenvolvimento. 6. Crie um código simples para criar novos módulos. 7. Implante os módulos recém-criados. 8. Testar módulos. 9. Use o Git para fazer solicitações de envio. O segundo tipo de público-alvo são desenvolvedores intermediários ou seniores que querem personalizar o OpenMRS para atender às necessidades da própria organização ou contribuir com o OpenMRS. Para esses desenvolvedores mais experientes, os dois documentos devem fornecer uma visão geral do OpenMRS e servir como um guia para direcionar os detalhes mais aprofundados das tecnologias no guia para desenvolvedores e em outros recursos. Os principais objetivos para desenvolvedores experientes são: 1. Entender o modelo de dados e a arquitetura do OpenMRS 2. Participe da comunidade do OpenMRS e aprenda a usar as ferramentas de comunicação. 3. Encontre links para repositórios de código do OpenMRS. 4. Encontre mais recursos detalhados.
plano do projeto
Fase de planejamento: • Aprimore as metas definidas na seção "Escopo" • Identifique conteúdos desatualizados • Produza esboços para os dois documentos • Apresente o esboço ao mentor e aos especialistas em matéria (SME) • Atualize o plano do projeto
Fase de desenvolvimento de conteúdo • Aprenda sobre o Docker, siga todas as etapas de instalação e produza um código de exemplo/teste simples • Entreviste PMEs para fazer perguntas • Desenvolva o primeiro rascunho dos dois documentos
Revisão e publicação de conteúdo • Autoedição do conteúdo • Envie os rascunhos completos aos revisores (orientador e SMEs) e aos usuários finais para receber feedback • Revisão do rascunho • Publique os dois documentos na página wiki do OpenMRS. • Escrever relatório de projeto
Trabalho preliminar
Eu trabalhei um pouco na configuração do ambiente de desenvolvimento no sistema Linux e do SDK do OpenMRS. Estou configurando o ambiente de desenvolvimento integrado. Vou continuar trabalhando na criação de módulos simples e na programação de código de teste.
Referências e discussões
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