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:
- INCF
- Redator técnico:
- hq
- Nome do projeto:
- Documentos de treinamento do LORIS para neurociência aberta e reproduzível
- Duração do projeto:
- De longa duração (5 meses)
Project description
I. Com abstração
O Longitudinal Online Research and Imaging System (LORIS) é uma plataforma de gerenciamento de projetos voltada para a Web voltada à pesquisa de neuroimagens e apoiando diversas iniciativas do Open Science. A documentação tem um papel importante em LORIS. Especificamente, a documentação ajuda os usuários e desenvolvedores da LORIS a entender os detalhes do software para que possam usar melhor a plataforma ou contribuir com o desenvolvimento do software. A documentação LORIS também deve ser atualizada. O objetivo deste projeto é ajudar o LORIS a aprimorar sua documentação.
II. Estado atual
No momento, o LORIS usa o Wiki do GitHub. Leia os documentos e o site do LORIS.ca para hospedar toda a documentação. Especificamente, a LORIS GitHub Wiki hospeda a maior parte da documentação do LORIS, e outros tutoriais, apresentações, guias de usuário e orientações do LORIS estão hospedados em diversas plataformas . A documentação atual do LORIS fornece guias para desenvolvedores e usuários do LORIS, mas poderia se beneficiar de mais desenvolvimento e organização, especialmente em atualizações de documentação e melhorias nos detalhes técnicos.
III. Benefícios para a comunidade
Ao aprimorar os documentos de treinamento do LORIS para neurociências reprodutíveis abertas, pesquisadores e desenvolvedores se beneficiariam de uma ferramenta mais fácil de usar, para melhorar a coleta de dados em seus estudos. Especificamente, o projeto pode atualizar e melhorar a documentação de instalação/configuração do LORIS, bem como materiais para os usuários finais que fornecem treinamento para novos usuários. Além disso, o objetivo do projeto será ajudar a migrar e atualizar a documentação do wiki do GitHub para LORIS para "Ler os Documentos". 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, este projeto atualizaria e melhoraria o conteúdo apresentando às pessoas o LORIS, seu contexto científico aberto e seus casos de uso.
IV. Pontos fortes pessoais para o projeto
Nos últimos anos, participei de vários projetos técnicos, pelos quais desenvolvi uma sólida base em escrita técnica. Especificamente, fui responsável pela redação de documentação em vários projetos anteriores em equipe e acredito que tenho experiência suficiente no uso de ferramentas técnicas de escrita, como o Read the Docs, Sphinx, Mkdocs, markdown, LaTeX etc. Enquanto isso, minha experiência anterior em cursos de STEM também melhorou minhas habilidades em comunicação técnica. Os documentos de treinamento do LORIS para projetos abertos de neurociência e reproduzíveis com o INCF seriam uma ótima oportunidade para aplicar minhas técnicas técnicas de escrita ao LORIS. Além disso, estou muito interessado no campo de neuroimagem e tenho tentado encontrar oportunidades para aplicar meu conhecimento técnico a essa área. Os documentos de treinamento do LORIS para projetos de neurociência e reproduzíveis abertos com o INCF seriam uma experiência valiosa para mim.
V. Resultados finais
- Migrar e atualizar a documentação atual do LORIS
- Revise, atualize e aprimore a documentação de instalação/configuração do LORIS, além de preencher as lacunas nos materiais para os usuários finais, fornecendo treinamento para os novos usuários
- Ajudar a gerar um diagrama de banco de dados para comunicar as relações de dados (por exemplo, assunto, visita ao estudo) e melhorar a visualização da arquitetura
- Ajudar a atualizar e melhorar a documentação da API LORIS
- Ajude a atualizar e melhorar o conteúdo apresentando o LORIS, o contexto científico aberto e os casos de uso, envolvendo vários formatos de mídia
VI. Cronograma
Vinculação comunitária (17 de agosto a 13 de setembro) a) Conhecer totalmente 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 de setembro a 20 de setembro) Atualize e migre a documentação LORIS do wiki do GitHub para "Ler os documentos".
Semana 2 (21 de setembro a 27 de setembro) a) Revisar os materiais atuais para usuários finais da LORIS. b) Começar a preencher lacunas nos materiais para usuários finais do LORIS, fornecendo treinamento para novos usuários com base na documentação atual.
Semana 3 (28 de setembro a 4 de outubro) Concluir as lacunas de preenchimento dos materiais para usuários finais da LORIS, fornecendo treinamento para novos usuários.
Semana 4 (5 a 11 de outubro) a) Compreender a arquitetura atual do banco de dados LORIS. b) Começar a implementar o diagrama do banco de dados na plataforma LORIS.
Semana 5 (12 de outubro a 18 de outubro) a) Concluir a tarefa de geração de diagrama de banco de dados LORIS. b) Revisar a API LORIS atual e começar a ajudar a melhorar a documentação da API.
Semana 6 (19 a 25 de outubro) Continue a trabalhar na melhoria da documentação da API LORIS.
Semana 7 (26 de outubro a 1o de novembro) Melhorias concluídas na documentação da API LORIS.
Semana 8 (de 2 a 8 de novembro) Analise o conteúdo atual apresentando o LORIS e comece a atualizar e melhorar o contexto da ciência aberta.
Semana 9 (9 a 15 de novembro) Concluir as atualizações e melhorias no contexto da ciência aberta no conteúdo de apresentação do LORIS às pessoas.
Semana 10 (16 a 22 de novembro) Ajude a atualizar e melhorar parte dos casos de uso no conteúdo de introdução do LORIS.
Semana 11 (23 a 29 de novembro) Conclua a atualização e a melhoria de todos os casos de uso no conteúdo de introdução ao LORIS.
Conclusão do projeto (30 de novembro a 5 de dezembro) a) Limpar todas as contribuições de documentação que criei. b) Mesclar todas as solicitações de envio criadas no GitHub e fechar todos os problemas que eu criei. c) Concluir meu relatório final do projeto e enviá-lo ao Google.
VII. Resultados futuros
Após a temporada de Documentos Google 2020, quero continuar minhas contribuições para a documentação do LORIS. Especificamente, gostaria de discutir com os desenvolvedores da LORIS sobre a possibilidade de continuar atualizando e criando documentação para novos lançamentos. Além disso, gostaria de reservar um tempo extra para revisar a documentação que criei durante meu projeto da temporada de documentos do Google e verificar se há mais espaço para melhorias. Por fim, como tenho um histórico relevante em engenharia, estou aberto a contribuir com outros aspectos do software LORIS no futuro, por exemplo, com o desenvolvimento de software.