En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Open3D
- Redactor técnico:
- Rohan Rathi
- Nombre del proyecto:
- Documentación técnica de las APIs de Python y C++
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Sinopsis:
El proyecto se dividirá en 4 partes: Actualizar y extender la guía para colaboradores de Open3D Documentación completa de la API de Python Documentación completa de la API de C++ Documentos de alto nivel de las estructuras de datos principales
Descripción:
En mi proyecto, planeo dividirlo en 4 partes:
Planeo completar y actualizar la guía para colaboradores para principiantes, que proporciona una guía paso a paso completa sobre cómo pueden crear el código fuente y la documentación, y unirse a la comunidad de desarrolladores. Además de una guía escrita, tengo la intención de hacer un video en el que se muestren los pasos exactos para compilar el código fuente del canal de YouTube. También agregaré una guía sobre cómo los desarrolladores nuevos pueden contribuir a la documentación realizando cambios en el código fuente compilado por Sphinx con pybind y doxygen.
Ampliar la documentación de la API de Python Actualmente, la API de Python contiene docstrings básicas para las clases y las funciones de miembro que proporcionan una descripción vaga de la funcionalidad. Planeo reformular la documentación de la API de Python, lo que facilita la comprensión de la API y aclara la funcionalidad. También tengo la intención de agregar vínculos a los conceptos relevantes de gráficos en 3D que se usan en diferentes áreas (p. ej., la matriz intrínseca que se usa en la cámara).
Completa la documentación de la API de C++. Actualmente, no hay cadenas de documentos equivalentes en la documentación de C++ en comparación con la documentación de Python. Mi intención es documentar en detalle las clases y sus funciones de miembros y miembros de datos asociados .
Documentos de alto y bajo nivel de las estructuras principales de datos. Mi intención es comprender el código de varias estructuras de datos, como TriangleMesh, LineSet y Octree, y agregar comentarios en la base de código, tanto para que los nuevos desarrolladores lo comprendan como para cualquier usuario. Además, mejoraremos los instructivos para proporcionar documentación de alto nivel sobre el uso y los conceptos involucrados en las estructuras. Proporcionaré ejemplos detallados del uso y agregaré vínculos relevantes a los conceptos involucrados en las estructuras. Si el tiempo lo permite, trabajaré en las tareas más simples, como documentar cómo realizar ciertas tareas que pueden ayudar a los usuarios nuevos a afiliarse al software.
Cronograma del proyecto:
Del 1 de agosto al 1 de septiembre:
Conocer a mi mentor y analizar con más detalle el nivel de documentación requerido en diferentes partes de la base de código y también analizar qué tan detallado debe ser la documentación de bajo nivel en comparación con la de alto nivel También dedicaré este tiempo a comprender la base de código y estudiaré los conceptos para poder documentarlos mejor.
Semanas 1 y 2:
Actualizaré y extenderé la guía para colaboradores. Mejoraré la documentación sobre cómo compilar el código fuente. También agregaré una sección para documentadores sobre cómo los colaboradores nuevos pueden ayudar en la documentación. También haré un video de YouTube en el que especificaré paso a paso cómo compilar el código fuente.
Semanas 3 a 5:
Trabajaré en la extensión de la API de Python. Reformula la documentación existente y escribe en detalle la documentación de los miembros existentes. También agregaré vínculos relevantes a conceptos relacionados para que los usuarios puedan familiarizarse mejor con los conceptos involucrados.
Semanas 6 a 8:
Los documentos actuales de C++ están incompletos en la mayor parte de la biblioteca, por lo que pasaré la mayor parte del tiempo completando los documentos de C++.
Semanas 9 a 11:
Durante este período, trabajaré en las estructuras de datos principales. Reestructura los instructivos de cada estructura de datos, proporciona una descripción general de alto nivel y documenta los detalles de uso de los ejemplos.
Semana final:
Usaré la última semana para preparar mi informe final del trabajo realizado durante el período de documentación de 12 semanas. También aprovecharé este tiempo para revisar y finalizar la documentación.