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:
- LuckInTheRain
- Nome do projeto:
- Extensão e melhoria da documentação ROOT
- Duração do projeto:
- De longa duração (5 meses)
Project description
O projeto tem o objetivo de melhorar a documentação de 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 técnicas de redação que posso fornecer para o projeto, também estou familiarizado com ROOT (6 e 7) e tenho conhecimento de outros componentes exigidos pelo projeto, como:
- C++
- Python
- Git/GitHub
- Ferramentas de construção de sites (html, markdown, Jekyll)
Eu identifico três partes principais na documentação ROOT:
- site https://root.cern,
- o guia de referência da classe C++ https://root.cern/doc/master/,
- o fórum https://root-forum.cern.ch (em inglês)
Parece que a documentação ROOT (o novo "manual ROOT") precisa ser melhorada e complementada nas seguintes áreas:
- Ele deve se tornar mais acessível e compreensível para não físicos, especialmente os capítulos introdutórios.
- Mais tutoriais explicando a funcionalidade geral de ROOT serão desenvolvidos.
- Alguns tópicos e desenvolvimentos novos serão incluídos com descrições e exemplos detalhados.
Entre as opções que posso listar:
- A vinculação do Python
- 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 RNtuple)
- Os novos formatos de dados de chave (RDataFrame e RNtuple) precisam de especificações técnicas e tutoriais detalhados.
Respostas a perguntas importantes dos usuários, como as postadas no fórum ROOT, precisarão ser incluídas na documentação. Isso exige uma análise detalhada das perguntas mais frequentes, seguidas por um período de síntese para traduzi-las em documentos no novo "Manual do ROOT" ou em novos tutoriais no Guia de referência.
Tutoriais que ilustram as funcionalidades fornecidas pelo ROOT 7.
- Novos histogramas ROOT 7
- Novos gráficos ROOT 7
Cronograma estimado (5 meses):
- Fase 1: definição de tarefas e escopo para documentação e tutoriais ROOT: duas semanas.
- Fase 2: reunir e analisar as perguntas importantes dos usuários no fórum ROOT (em inglês): duas semanas
- Fase 3: redação da documentação ROOT: oito semanas.
- Fase 4: desenvolvimento de tutoriais: oito semanas
Por fim, gostaria de acrescentar que eu já contribuí com a documentação ROOT no ano passado com um projeto de longo prazo da temporada de documentos do Google. Eu defini a nova estrutura do Manual. A proposta deste ano contribuirá para a conclusão de outros aspectos da documentação que ainda estão faltando na ROOT.