Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- OpenMRS
- Redator técnico:
- Arco-íris
- Nome do projeto:
- Melhoria da documentação técnica do OpenMRS para novos desenvolvedores
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Justificativa
Com as consequências da pandemia da COVID-19 no mundo, ficou ainda mais evidente que um sistema de prontuários médicos de código aberto, como o OpenMRS, pode ser parte da solução para esse tipo de crise. Para ajudar os novos desenvolvedores a navegar pelo ecossistema do OpenMRS, reduzir o processo de integração e permitir que mais novos usuários contribuam rapidamente para o desenvolvimento do OpenMRS, é necessário ter documentações concisas, claras e atualizadas. Há dois documentos para novos desenvolvedores: • Primeiras etapas como desenvolvedor • Manual do desenvolvedor No entanto, alguns conteúdos estão desatualizados e o formato precisa ser melhorado. 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 reformate 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 tem menos etapas, para facilitar o processo para o usuário. b. Reorganize a ordem das etapas. Algumas delas podem ser combinadas. c. Liste links para outras páginas wiki em tabelas para que as instruções sejam 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 saber mais detalhes. b. O capítulo "Configuração" precisa ser movido antes do capítulo "Processo de desenvolvimento".
Atualize o conteúdo. Para o documento "Primeiros passos como desenvolvedor": a. 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 o IntelliJ e o Eclipse c. Adicione um link para o Manual do desenvolvedor ou o Guia do desenvolvedor, quando aplicável. d. Verifique se todo o conteúdo do link 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 juntas, adicionar links para reuniões da equipe e discussões entre equipes, ajudar novos desenvolvedores a encontrar equipes de que querem participar. c. Adicionar o Docker no capítulo de configuração do sistema. d. Adicione 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. e. Adicione códigos de exemplo simples para mostrar como cada tipo de módulo é criado e implantado. f. Adicionar exemplos de teste simples para cada tipo de módulo.
Análise de público-alvo
O público-alvo do Manual do desenvolvedor e "Primeiros passos como desenvolvedor" são desenvolvedores com pouco ou nenhum conhecimento de OpenMRS. Existem dois tipos de desenvolvedores: o primeiro é composto por desenvolvedores júniores, com pouca ou nenhuma experiência em desenvolvimento de software. Por exemplo, alunos 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 para os projetos do OpenMRS em um período relativamente curto. Os principais objetivos para desenvolvedores júnior são: 1. Entender as habilidades necessárias para participar do OpenMRS (MySQL, Java Spring. React.js, Git etc.) e encontrar os recursos para aprender essas habilidades. 2. Participe da comunidade OpenMRS e aprenda as ferramentas de comunicação. 3. Configure o ambiente e o ambiente de desenvolvimento integrado. 4. Instale o SDK do OpenMRS. 5. Entender o fluxo de trabalho de desenvolvimento. 6. Produza um código simples para criar novos módulos. 7. Implantar módulos recém-criados. 8. Módulos de teste. 9. Use o Git para fazer solicitações de envio. O segundo tipo de público são desenvolvedores de nível intermediário ou sênior que querem personalizar o OpenMRS para atender às necessidades da própria organização ou contribuir com o OpenMRS. Para desenvolvedores mais experientes, os dois documentos devem fornecer uma visão geral do OpenMRS e servir como guia para direcioná-los a detalhes mais aprofundados sobre tecnologias no Guia do desenvolvedor e em outros recursos. As principais metas para desenvolvedores experientes são: 1. Entender o modelo de dados e a arquitetura do OpenMRS 2. Participe da comunidade OpenMRS e aprenda as ferramentas de comunicação. 3. Encontre links para repositórios de código OpenMRS. 4. Encontre recursos mais detalhados.
plano do projeto
Fase de planejamento: • Refinar as metas definidas na seção "Escopo" • Identificar conteúdos desatualizados • Criar descrições para os dois documentos • Apresentar o resumo para o mentor e especialistas (SMEs) • Atualizar o plano do projeto
Fase de desenvolvimento de conteúdo • Aprender sobre o Docker, passar por todas as etapas de instalação e produzir um exemplo simples de código/código de teste • Entrevistar SMEs para fazer perguntas • Desenvolver o primeiro rascunho dos dois documentos
Revisão e publicação de conteúdo • autoedição do conteúdo • Envie os rascunhos concluídos aos revisores (mentor e SMEs) e usuários finais para receber feedback. • Revisar o rascunho. • Publique os dois documentos na página da wiki do OpenMRS. • Escrever relatório do projeto
Trabalho preliminar
Fiz algumas tarefas 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 escrita de códigos de teste.
Referências e discussões
https: