Olá!
Passando para compartilhar nosso progresso para melhorar a documentação das atividades relacionadas do OpenRedu. Nossa ideia era contribuir criando um roadmap de atividades, ou seja, uma forma visual de mapear o que está em andamento e outras tarefas e ideias futuras.
Primeiro, pesquisamos por alguns formatos de roadmap que poderiam ser úteis no contexto do OpenRedu. Percebemos que o ideal seria que houvesse um board de atividades centralizado, de fácil acesso para todos os envolvidos na comunidade e que funcionasse como referência para informações sobre as atividades em andamento e as ideias a serem executadas. Assim, concluímos que utilizar a funcionalidade de ‘Projetos’ do próprio GitHub do OpenRedu seria o ideal, uma vez que ele já estaria integrado às issues e aos repositórios do projeto, além do acesso ser aberto a todas as interessadas.
Usando essa funcionalidade, toda issue aberta em repositórios da organização podem ser adicionadas como cards no quadro, o que tornaria menos complexa a adição e manutenção dessas atividades.
Além disso, também notamos que seria interessante ter um template de user story possuindo todas as informações necessárias para a execução da atividade em questão - útil tanto para quem propõe a tarefa, que deixa anotadas todas as informações que possui, tanto para quem vai trabalhar na atividade. Assim, também propomos um template a ser preenchido no momento de criar as atividades no board.
Infelizmente, por questões de visibilidade dos repositórios, não pudemos avançar muito na criação do board e adição das atividades e issues existentes e já mapeadas, mas o resultado tem muito potencial para contribuir muito com o acompanhamento das tarefas, principalmente a médio e longo prazo.
Um exemplo de como o board pode ficar está neste projeto de exemplo. Algumas issues com descrição utilizando o template estão disponíveis no board (issues #4 e #9). O template de user story está colado logo abaixo. Os próximos passos são: criar o board no projeto do GitHub e adicionar as issues como cards; criar issues com as próximas atividades mapeadas por outros colaboradores do projeto; adicionar o template como template de preenchimento no momento de criar uma issue.
Sintam-se à vontade para sugerir alterações e tornarmos o OpenRedu cada vez mais bem documentado e receptivo para novas contribuições.
Muito obrigada!
Autores:
@penelope
@Lucas Tavora
TEMPLATE DE USER STORY
Título
[Título da atividade que será exibida no board do projeto; o ideal é que seja explicativo e sucinto.]
Descrição
[Descrever brevemente o que é a atividade e quais são os seus objetivos.]
Grau de complexidade
[Apontar qual o grau de complexidade da tarefa, entre as opções: baixo, médio e alto.]
Área de trabalho / habilidades necessárias
[Apontar em qual área se encaixa a atividade em questão: produto, UX/UI design, desenvolvimento, comunicação (ou outras opções que podem vir a surgir). Dentre as habilidades, pode-se incluir a linguagem de programação ou ferramenta utilizada para a tarefa, algum conhecimento prévio necessário de outra atividade relacionada, etc.]
Escopo
[Listar o que faz parte dessa atividade específica e o que será entregue.]
Como desenvolver
[Explicar como os usuários podem desenvolver o que será entregue nesta atividade. Forneça exemplos e instruções claras.]
Como contribuir / Próximos passos
[Explicar como é possível contribuir posteriormente para essa atividade. Incluir informações sobre como configurar o ambiente de desenvolvimento, realizar testes manuais, etc.]
Dependências
[Listar as dependências necessárias para essa atividade.]
Autoria
[Incluir informações sobre as pessoas envolvidas na atividade / marcar os usuários do GitHub.]
Observações
[Incluir outras informações relevantes sobre a atividade.]