Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Open3D
- Technical writer:
- Rohan Rathi
- Nome progetto:
- Documentazione tecnica dell'API Python e C++
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Trama:
Il progetto sarà diviso in 4 parti: Esegui l'upgrade e l'estensione della guida per i collaboratori Open3D Completa la documentazione dell'API Python Completa la documentazione dell'API C++ Documenti di alto livello sulle strutture di dati principali
Descrizione:
Nel mio progetto ho intenzione di suddividerlo in 4 parti:
Ho intenzione di completare e aggiornare la guida per i collaboratori per i nuovi arrivati, che fornisce una guida passo passo completa su come creare il codice sorgente, la documentazione e unirsi alla community degli sviluppatori. Oltre a una guida scritta, intendo realizzare un video che mostri i passaggi esatti per la creazione del codice sorgente per il canale YouTube. Aggiungerò anche una guida su come i nuovi sviluppatori possono contribuire alla documentazione apportando modifiche al codice sorgente creato da Sphinx utilizzando pybind e doxygen.
Estendi la documentazione dell'API Python. Attualmente l'API Python contiene docstring di base per le classi e le funzioni dei membri che forniscono una vaga descrizione della funzionalità. Intendo riformulare la documentazione dell'API Python per rendere l'API più comprensibile e più chiara la funzionalità. Intendo anche aggiungere link ai concetti di grafica 3D pertinenti utilizzati in diverse aree (ad es.: matrice intrinseca utilizzata in Fotocamera)
Completa la documentazione dell'API C++. Al momento, nella documentazione C++ non esistono docstring equivalenti rispetto alla documentazione Python. Intendo documentare in dettaglio le classi e le funzioni dei membri associate e i membri dei dati .
Documenti di alto e basso livello sulle strutture di dati di base. Intendo comprendere il codice di varie strutture di dati come TriangleMesh, LineSet, Octree e aggiungere commenti nel codebase, sia per i nuovi sviluppatori che per gli eventuali utenti. Oltre a fornire una documentazione di alto livello sull'uso e sui concetti coinvolti nelle strutture, puoi migliorare i tutorial. Fornirò esempi dettagliati dell'utilizzo e aggiungerò link pertinenti ai concetti coinvolti nelle strutture. Se il tempo lo consente, mi occuperò di quelle più semplici, come documentare l'esecuzione di determinate attività che possono aiutare i nuovi utenti ad affiliarsi al software.
Pianificazione del progetto
Dal 1° agosto al 1° settembre:
Fai conoscenza con il mio mentore e discuti in modo più approfondito del livello di documentazione richiesto in diverse parti del codebase e discuti di quanto sia approfondito la documentazione di basso e di alto livello. Inoltre, dedicherò questo tempo a comprendere il codebase e studierò i concetti in modo da documentarli meglio.
Settimana 1 e 2:
Aggiornerò ed estenderò la guida per i collaboratori. Migliorerò la documentazione su come creare il codice sorgente. Aggiungerò anche una sezione dedicata ai documentari su come i nuovi collaboratori possono aiutare nella documentazione. Creerò anche un video di YouTube in cui specifichiamo passo passo come creare il codice sorgente.
Settimana 3-5:
Lavorerò per estendere l'API Python. Riformula la documentazione esistente e scrivi in dettaglio la documentazione dei membri esistenti. Aggiungerò inoltre link pertinenti a concetti correlati in modo che gli utenti possano familiarizzare meglio con i concetti coinvolti.
Settimana 6-8:
Gli attuali documenti in C++ sono incompleti per gran parte della raccolta, quindi dedicherò la maggior parte del tempo a compilare i documenti in C++.
Settimana 9 - 11:
Durante questo periodo, lavorerò alle strutture di base dei dati. Ristruttura i tutorial di ogni struttura di dati, fornisci una panoramica generale e documenta dettagli di utilizzo di esempio.
Settimana finale:
Userò l'ultima settimana per preparare il mio rapporto finale sul lavoro svolto durante il periodo di documentazione di 12 settimane. Dedicherò anche questo tempo a esaminare e finalizzare la documentazione.