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:
- CERN-HSF
- Redator técnico:
- João
- Nome do projeto:
- CERN-HSF: documentação de ROOT para adoção do público geral, vinculações dinâmicas do Python e tutoriais
- Duração do projeto:
- De longa duração (5 meses)
Project description
CERN-HSF - Documentação ROOT para adoção do público geral, vinculações dinâmicas do Python e tutoriais Mentor: Olivier Couet, Axel Naumann
Abstrata: a documentação é essencial para uma adoção de software bem-sucedida e eficiente pelos usuários. Uma documentação do usuário clara, precisa e abrangente facilita a proficiência dos usuários com o software enquanto eles se esforçam para atingir seus objetivos. Nessa linha, exemplos explícitos e tutoriais servem como ferramentas poderosas pelas quais os usuários podem aprender rapidamente.
À medida que examinamos o uso de ROOT por físicos, pesquisadores e desenvolvedores no espaço de análise e visualização de dados para física, há um reconhecimento dos benefícios de uma documentação atualizada e fácil de usar. Em particular, devido à amplitude do código-fonte e ao crescimento dele, o sistema de documentação se beneficia da evolução paralela para permitir que os usuários maximizem tudo o que a ROOT tem a oferecer.
Resumo e análise da documentação atual Atualmente, a documentação do usuário oferece um guia que permite aos físicos adotar o ROOT com mais facilidade em relação ao público geral. Além disso, dentro de certos tópicos, como Vinculações dinâmicas do Python, é possível fazer melhorias para uma documentação mais abrangente e clara. Da mesma forma, o novo formato de dados RNTuple não tem as especificações detalhadas necessárias. Por fim, a documentação atual não tem tutoriais relacionados ao ROOT 7.
Metodologia: após a conversa com Olivier, parece que, para resolver os problemas mencionados, o foco principal precisa ser identificar lacunas de conhecimento entre pesquisadores especializados e o público em geral, criar documentação para preencher essa lacuna, escrever uma documentação mais detalhada sobre vinculações dinâmicas do Python, implementar "tutoriais de análise moderna" para o ROOT 7 e criar especificações técnicas detalhadas para o RNTuple. Nessa linha, durante o processo, a documentação pode incorporar notebooks do Jupyter para que ferramentas de aprendizado tangíveis e interativas possam ajudar os usuários.
Cronograma: Estima-se que as etapas do projeto sejam: Identificar lacunas de conhecimento entre pesquisadores especializados e um público geral (durante a leitura da documentação atual e do código-fonte) → 1-2 semanas Criar e refatorar a documentação para preencher essa lacuna → 3 semanas Escrever uma documentação mais detalhada de Vinculações Python dinâmicas → 3 semanas Implementar tutoriais detalhados para Vinculações Python dinâmicas → 3 semanas Implementar o projeto para ROOT 7 semanas Implementar o projeto para ROOT 7
Resultados e diretrizes para o sucesso: Documentação de usuário unificada sem lacunas Documentação do usuário completamente atualizada para refletir os recursos mais recentes, ou seja, novas classes derivadas Tutoriais por meio dos notebooks do Jupyter