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:
- Open3D (em inglês)
- Redator técnico:
- Rohan Rathi (em inglês)
- Nome do projeto:
- Documentação técnica da API Python e C++
- Duração do projeto:
- Duração padrão (três meses)
Project description
Sinopse:
O projeto será dividido em quatro partes: Atualizar e estender o guia do colaborador do Open3D Documentação completa da API Python Documentação completa da API C++ Documentos de alto nível das estruturas de dados principais
Descrição:
No meu projeto, pretendo dividir o projeto em quatro partes:
Pretendo concluir e atualizar o guia de colaboradores para iniciantes, que oferece um guia detalhado e abrangente sobre como criar o código-fonte, elaborar a documentação e participar da comunidade de desenvolvedores. Além de um guia escrito, pretendo fazer um vídeo mostrando as etapas exatas de como criar o código-fonte do canal do YouTube. Também vou adicionar um guia sobre como novos desenvolvedores podem contribuir para a documentação fazendo mudanças no código-fonte criado pelo Sphinx usando pybind e doxygen.
Ampliar a documentação da API Python. No momento, a API Python contém docstrings básicas para as classes e funções de membro que fornecem uma descrição vaga da funcionalidade. Pretendo reformular a documentação da API Python para facilitar a compreensão e tornar a funcionalidade mais clara. Também pretendo adicionar links para os conceitos relevantes de gráficos 3D usados em diferentes áreas (por exemplo, matriz intrínseca usada na câmera).
Conclua a documentação da API C++. No momento, não há docstrings equivalentes na documentação do C++ em comparação com a documentação do Python. Pretendo documentar em detalhes as classes e as funções de membro e de dados associadas a elas .
Documentos de alto e baixo nível das estruturas de dados principais. Pretendo entender o código de várias estruturas de dados, como TriangleMesh, LineSet, Octree, e adicionar comentários à base de código, tanto para novos desenvolvedores quanto para qualquer usuário. Além de melhorar os tutoriais, fornecemos documentação de alto nível sobre o uso e os conceitos envolvidos nas estruturas. Vou fornecer exemplos detalhados do uso e adicionar links relevantes aos conceitos envolvidos nas estruturas. Se tiver tempo, trabalharei nas tarefas mais simples, como documentar como realizar certas tarefas que podem ajudar novos usuários a se afiliarem ao software.
Cronograma do projeto-
De 1o de agosto a 1o de setembro:
Conhecer meu mentor e discutir em mais detalhes o nível de documentação necessário em diferentes partes da base de código e também discutir o nível de detalhamento da documentação de nível baixo e alto. Também vou dedicar esse tempo para entender a base do código e estudar os conceitos para documentá-los melhor.
Semanas 1 e 2:
Vou atualizar e ampliar o guia para colaboradores. Vou melhorar a documentação sobre como criar o código-fonte. Também vou adicionar uma seção sobre como os novos colaboradores podem ajudar na documentação. Também vou fazer um vídeo no YouTube especificando passo a passo como criar o código-fonte.
Semanas 3 a 5:
Vou trabalhar na extensão da API Python. Reformule a documentação existente e escreva em detalhes a documentação dos membros atuais. Também vou adicionar links relevantes para conceitos relacionados para que os usuários possam se familiarizar melhor com os conceitos envolvidos.
Semanas 6 a 8:
As documentações atuais de C++ estão incompletas para a maior parte da biblioteca. Por isso, vou passar a maior parte do tempo preenchendo as documentações de C++.
Semanas 9 a 11:
Durante esse período, vou trabalhar nas estruturas de dados principais. Reestruturar os tutoriais de cada estrutura de dados, fornecer uma visão geral de alto nível e documentar detalhes de uso de exemplo.
Última semana:
Vou usar a semana final para preparar meu relatório final do trabalho realizado durante o período de documentação de 12 semanas. Também vou usar esse tempo para revisar e finalizar a documentação.