Esta página contiene 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
- Escritor técnico:
- Rohan Rathi
- Nombre del proyecto:
- Documentación técnica de la API de Python y la API de 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 del colaborador de Open3D Completar la documentación de la API de Python Completar la documentación de la API de C++ Documentos de alto nivel de las estructuras de datos principales
Descripción:
En mi proyecto pienso dividirlo en 4 partes:
Pienso completar y actualizar la guía de colaboradores para principiantes, que brinda una guía paso a paso completa sobre cómo compilar el código fuente, obtener la documentación y unirse a la comunidad de desarrolladores. Además de una guía escrita, quiero hacer un video en el que muestre los pasos exactos sobre cómo crear el código fuente para el canal de YouTube. También agregaré una guía sobre cómo los nuevos desarrolladores pueden contribuir a la documentación realizando cambios en el código fuente creado por Sphinx con pybind y doxygen.
Extender la documentación de la API de Python Actualmente, la API de Python contiene docstrings básicas para las clases y las funciones de los miembros, lo que proporciona una descripción imprecisa de la funcionalidad. Planeo reformular la documentación de la API de Python para que sea más fácil de entender y la funcionalidad sea más clara. También deseo agregar vínculos a los conceptos relevantes de los gráficos 3D utilizados en diferentes áreas (p. ej., la matriz intrínseca utilizada en la cámara).
Completa la documentación de la API de C++. Actualmente, no hay docstrings equivalentes en la documentación de C++ en comparación con la documentación de Python. Quiero documentar en detalle las clases y sus funciones miembro asociadas y los miembros de datos .
Documentos de alto y bajo nivel de las estructuras de datos principales. Quiero comprender el código de varias estructuras de datos, como TriangleMesh, LineSet y Octree, y agregar comentarios a la base de código, tanto para los nuevos desarrolladores como para cualquier usuario. También proporciona documentación de alto nivel sobre el uso y los conceptos involucrados en las estructuras mediante la mejora de los instructivos. Proporcionaré en detalle ejemplos de uso y agregaré enlaces relevantes a los conceptos involucrados en las estructuras. Si el tiempo lo permite, trabajaré en las tareas más sencillas, como documentar la forma de realizar ciertas tareas que pueden ayudar a los nuevos usuarios a afiliarse al software.
Programación del proyecto:
Del 1 de agosto al 1 de septiembre:
Familiarízate con mi mentor y debate en mayor profundidad el nivel de documentación requerido en las diferentes partes de la base de código y también analiza en profundidad 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 de documentadores sobre cómo los nuevos colaboradores pueden ayudar en la documentación. También crearé un video de YouTube en el que especificaré paso a paso cómo compilar el código fuente.
Semanas 3 a 5:
Trabajaré para extender la API de Python. Reformula la documentación existente y escribe en detalle la documentación de los miembros existentes. También agregaré enlaces relevantes a conceptos relacionados para que los usuarios puedan familiarizarse mejor con los conceptos involucrados.
Semanas 6 a 8:
Los documentos de C++ actuales están incompletos para 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 centrales. Reestructura los instructivos de cada estructura de datos, proporciona una descripción general de alto nivel y documenta los detalles de uso de ejemplo.
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 dedicaré este tiempo a revisar y finalizar la documentación.