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:
- CERN-HSF (link em inglês)
- Redator técnico:
- LuckInTheRain
- Nome do projeto:
- Como ampliar e melhorar a documentação do ROOT
- Duração do projeto:
- De longa duração (5 meses)
Project description
O objetivo do projeto é melhorar a documentação do ROOT, que é o principal sistema de software para análise e apresentação de dados usado pela comunidade de física de alta energia em todo o mundo.
Além das habilidades de redator técnico que posso oferecer para o projeto, também tenho experiência com ROOT (6 e 7) e conhecimento de outros componentes exigidos pelo projeto, como:
- C++
- Python
- Git/GitHub
- Ferramentas de construção de sites da Web (HTML, Markdown, Jekyll)
Identifiquei três partes principais na documentação do ROOT:
- o site https://root.cern,
- o Guia de referência de classe C++: https://root.cern/doc/master/
- o fórum https://root-forum.cern.ch
Parece que a documentação do ROOT (o novo "manual do ROOT") precisa ser melhorada e complementada nas seguintes áreas:
- O texto precisa ficar mais acessível e compreensível para pessoas que não são físicos, principalmente os capítulos introdutórios.
- Mais tutoriais explicando a funcionalidade geral do ROOT serão desenvolvidos.
- Alguns tópicos e desenvolvimentos novos serão incluídos com descrições e exemplos detalhados.
Entre eles, posso citar:
- Vinculação do Python
- As bibliotecas matemáticas
- Descrição manual para ferramentas gráficas de alto nível (TRatioPLot, THStack)
- As novas ferramentas de análise de mineração de dados (RDataFrame e RNtupla)
- Os novos formatos de dados principais (RDataFrame e RNtuple) precisam de especificações técnicas e tutoriais detalhados.
As respostas a perguntas importantes dos usuários, como as postadas no fórum ROOT, precisam ser incluídas na documentação. Isso requer uma análise detalhada das perguntas mais frequentes, seguida de um período de síntese para transformá-las em partes da documentação do novo "Manual ROOT" ou em novos tutoriais do Guia de referência.
Tutoriais que ilustram as funcionalidades fornecidas pelo ROOT 7.
- Novos histogramas do ROOT 7
- Novos gráficos do ROOT 7
Cronograma estimado (cinco meses):
- Fase 1: definição de tarefas e escopo para a documentação e os tutoriais do ROOT: duas semanas.
- Fase 2: coletar e analisar perguntas importantes dos usuários no fórum ROOT: duas semanas
- Fase 3: elaboração da documentação do ROOT: 8 semanas.
- Fase 4: desenvolvimento de tutoriais: 8 semanas
Por fim, devo acrescentar que já contribuí para a documentação ROOT no ano passado com um projeto de longo prazo do Google Season of Docs. Eu defini a nova estrutura do manual. A proposta deste ano vai contribuir para a conclusão de outros aspectos da documentação que ainda faltam no projeto ROOT.