Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- INCF
- Redator técnico:
- hq
- Nome do projeto:
- Documentos de treinamento do LORIS para neurociência aberta e reproduzível
- Duração do projeto:
- Longa duração (cinco meses)
Project description
I. Resumo
O Longitudinal Online Research and Imaging System (LORIS) é uma plataforma de gerenciamento de projetos voltada para a Web para pesquisas de neuroimagem,que oferece suporte a várias iniciativas de ciência aberta. A documentação tem um papel importante no LORIS. Especificamente, a documentação ajuda os usuários e desenvolvedores do LORIS a entender os detalhes do software para que eles possam usar melhor a plataforma ou contribuir para o desenvolvimento do software. Enquanto isso, a documentação do LORIS também precisa ser atualizada. O objetivo deste projeto é ajudar o LORIS a melhorar a documentação.
II. Estado atual
Atualmente, o LORIS usa o Github Wiki, o Read the Docs e o site LORIS.ca para hospedar toda a documentação. Especificamente, o LORIS GitHub Wiki hospeda a maior quantidade de documentação do LORIS, e outros tutoriais, apresentações, guias do usuário e tutoriais do LORIS são hospedados em várias plataformas . A documentação atual do LORIS oferece guias para desenvolvedores e usuários do LORIS, mas pode se beneficiar de mais desenvolvimento e organização, especialmente em atualizações de documentação e melhorias em detalhes técnicos.
III. Benefícios para a comunidade
Ao melhorar os documentos de treinamento do LORIS para neurociência aberta e reproduzível, pesquisadores e desenvolvedores se beneficiam de uma ferramenta mais fácil de usar para melhorar a coleta de dados nos estudos. Especificamente, o projeto pode atualizar e melhorar a documentação de instalação/configuração do LORIS, bem como os materiais do usuário final que fornecem treinamento para novos usuários. Além disso, o projeto tem como objetivo ajudar a migrar e atualizar a documentação do wiki do GitHub da LORIS para o Read the Docs. Enquanto isso, o projeto pode fornecer um diagrama de banco de dados para comunicar as relações de dados e melhorar a visualização da arquitetura. Por fim, esse projeto atualizou e melhorou o conteúdo que apresenta a LORIS, o contexto da ciência aberta e os casos de uso.
IV. Pontos fortes pessoais para o projeto
Nos últimos anos, participei de vários projetos técnicos e desenvolvi um forte histórico em redação técnica. Especificamente, fui responsável pela redação de documentação em vários projetos de equipe anteriores e acredito que tenho experiência suficiente no uso de ferramentas de redação técnica, como Read the Docs, Sphinx, Mkdocs, markdown, LaTeX etc. Além disso, minha experiência anterior de ensino em cursos de STEM também melhorou minhas habilidades em comunicação técnica. Os documentos de treinamento do LORIS para projetos de neurociência reproduzíveis abertos com o INCF seriam uma ótima oportunidade para aplicar minhas técnicas de redação técnica ao LORIS. Além disso, tenho muito interesse na área de neuroimagem e tenho tentado encontrar oportunidades para aplicar meu conhecimento técnico a essa área. Os documentos de treinamento do LORIS para projetos abertos e reproduzíveis de neurociência com o INCF seriam uma experiência valiosa para mim.
V. Resultados
- Migrar e atualizar a documentação atual do LORIS
- Revise, atualize e melhore a documentação de instalação/configuração do LORIS e preencha as lacunas nos materiais para usuários finais que oferecem treinamento para novos usuários
- Ajudar a gerar um diagrama de banco de dados para comunicar as relações de dados (por exemplo, sujeito, visita de estudo) e melhorar a visualização da arquitetura
- Ajude a atualizar e melhorar a documentação da API LORIS
- Atualizar e melhorar o conteúdo que apresenta o LORIS, o contexto da ciência aberta e os casos de uso, envolvendo vários formatos de mídia.
VI. Cronograma
Community Bonding (17 de agosto a 13 de setembro) a) Familiarização completa com o software LORIS e o fluxo de trabalho da equipe. b) Revisar, atualizar e melhorar a documentação de instalação/configuração do LORIS.
Semana 1 (14 a 20 de setembro) Atualize e migre a documentação do LORIS do wiki do GitHub para o Read the Docs.
Semana 2 (21 a 27 de setembro) a) Analisar os materiais atuais do LORIS para usuários finais. b) Começar a preencher lacunas nos materiais do usuário final do LORIS, oferecendo treinamento para novos usuários com base na documentação atual.
Semana 3 (28 de setembro a 4 de outubro) Terminar de preencher as lacunas nos materiais do usuário final do LORIS, oferecendo treinamento para novos usuários.
Semana 4 (5 a 11 de outubro) a) Compreenda a arquitetura atual do banco de dados do LORIS. b) Comece a implementar o diagrama de banco de dados da plataforma LORIS.
Semana 5 (12 a 18 de outubro) a) Concluir a tarefa de geração de diagrama de banco de dados do LORIS. b) Analisar a API atual do LORIS e começar a ajudar a melhorar a documentação da API.
Semana 6 (19 a 25 de outubro) Continuamos trabalhando na melhoria da documentação da API LORIS.
Semana 7 (26 de outubro a 1º de novembro) Conclusão da melhoria na documentação da API LORIS.
Semana 8 (2 a 8 de novembro) Revise o conteúdo atual que apresenta o LORIS às pessoas e comece a atualizar e melhorar o contexto da ciência aberta.
Semana 9 (9 a 15 de novembro) Conclua as atualizações e melhorias do contexto da ciência aberta no conteúdo de apresentação do LORIS.
Semana 10 (16 a 22 de novembro) Ajude a atualizar e melhorar parte dos casos de uso nos conteúdos que apresentam o LORIS às pessoas.
Semana 11 (23 a 29 de novembro) Conclua a atualização e melhoria de todos os casos de uso nos conteúdos que apresentam o LORIS às pessoas.
Finalização do projeto (30 de novembro a 5 de dezembro) a) Limpar todas as contribuições de documentação que criei. b) Mesclar todos os pull requests criados no GitHub e fechar todos os problemas que criei. c) Concluir meu relatório final do projeto e enviar o relatório ao Google.
VII. Entregas futuras
Depois da Temporada de Documentos do Google 2020, gostaria de continuar minhas contribuições para a documentação do LORIS. Mais especificamente, gostaria de discutir com os desenvolvedores do LORIS a possibilidade de continuar atualizando e criando documentação para novas versões. Além disso, gostaria de analisar a documentação que criei durante meu projeto do Google Season of Docs e verificar se há mais espaço para melhorias. Por fim, como tenho experiência relevante em engenharia, estou disponível para contribuir com outros aspectos do software LORIS no futuro, por exemplo, desenvolvimento de software.