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:
- Open3D
- Redator técnico:
- Rohan Rathi
- Nome do projeto:
- Documentação técnica de Python e API C++
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Sinopse:
O projeto será dividido em quatro partes: Fazer upgrade e ampliar o guia do colaborador Open3D Documentação completa da API Python Documentação completa da API C++ Documentos de alto nível das principais estruturas de dados
Descrição:
No meu projeto, pretendo dividi-lo em quatro partes:
Planejo concluir e atualizar o guia de colaboradores para iniciantes, que fornece um guia passo a passo abrangente sobre como eles podem criar o código-fonte, desenvolver 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 para o canal do YouTube. Também adicionarei um guia sobre como novos desenvolvedores podem contribuir com a documentação fazendo alterações no código-fonte criado pelo sphinx usando pybind e doxygen.
Ampliar a documentação da API Python. Atualmente, a API Python contém docstrings básicas para as classes e funções de membro que fornecem uma vaga descrição da funcionalidade. Planejo reformular a documentação da API em Python para tornar a API mais fácil de entender e a funcionalidade mais clara. Também pretendo adicionar links para conceitos relevantes de gráficos 3D usados em diferentes áreas (por exemplo, matriz intrínseca usada na câmera)
Preencha a documentação da API em C++. Atualmente, não há docstrings equivalentes na documentação do C++ em comparação com a documentação do Python. Pretendo documentar detalhadamente as classes e suas funções de membro associadas e membros de dados .
Documentos de alto e baixo nível das principais estruturas de dados. Quero entender o código de várias estruturas de dados, como TriangleMesh, LineSet, Octree e adicionar comentários na base de código, tanto para novos desenvolvedores quanto para quaisquer usuários. bem como fornecer documentação de alto nível sobre o uso e os conceitos envolvidos nas estruturas, melhorando os tutoriais. Vou fornecer exemplos detalhados do uso e adicionar links relevantes para os conceitos envolvidos nas estruturas. Se tiver tempo, trabalharei em tarefas mais simples, como documentar como realizar certas tarefas que podem ajudar novos usuários a se afiliarem ao software.
Cronograma do projeto-
1o de agosto a 1o de setembro:
Conhecer meu mentor e conversar mais sobre o nível de documentação necessária em diferentes partes da base de código, além de discutir como fazer isso na documentação de nível baixo e alto. Também vou passar esse tempo entendendo a base do código e estudar os conceitos para documentá-los melhor.
Semanas 1 e 2:
Vou atualizar e estender o guia dos colaboradores. Vou melhorar a documentação sobre como criar o código-fonte. Também adicionarei uma seção de documentadores sobre como novos colaboradores podem ajudar na documentação. Também vou fazer um vídeo do YouTube especificando o passo a passo de 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 documentação detalhada dos membros atuais. Também adicionarei links relevantes para conceitos relacionados para que os usuários possam se familiarizar melhor com os conceitos envolvidos.
Semanas 6 a 8:
Os documentos atuais do C++ estão incompletos na maior parte da biblioteca, então vou passar a maior parte do tempo preenchendo os documentos do C++.
Semanas 9 a 11:
Durante esse período, trabalharei nas principais estruturas de dados. Reestruture os tutoriais de cada estrutura de dados, forneça uma visão geral de alto nível e documente detalhes de uso de exemplos.
Semana final:
Usarei a última semana para preparar meu relatório final do trabalho realizado durante meu período de documentação de 12 semanas. Também vou usar esse tempo para analisar e finalizar a documentação.