Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Open3D
- Rédacteur technique:
- Rohan Rathi
- Nom du projet:
- Documentation technique sur les API Python et C++
- Durée du projet:
- Durée standard (3 mois)
Project description
Synopsis :
Le projet comporte quatre parties : Mettre à niveau et étendre le guide du contributeur Open3D Documentation complète sur l'API Python Documentation complète sur l'API C++ Documentation de haut niveau sur les principales structures de données
Description :
Dans mon projet, je prévois de le diviser en quatre parties:
Je prévois de compléter et de mettre à jour le guide des contributeurs destiné aux nouveaux utilisateurs, qui fournit un guide par étapes complet expliquant comment créer le code source, la documentation et rejoindre la communauté des développeurs. En plus d'un guide écrit, je souhaite réaliser une vidéo présentant les étapes exactes de la création du code source de la chaîne YouTube. J'ajouterai également un guide sur la façon dont les nouveaux développeurs peuvent contribuer à la documentation en modifiant le code source créé par Sphinx à l'aide de pybind et de doxygen.
Étendre la documentation de l'API Python. Actuellement, l'API Python contient des docstrings de base pour les classes et les fonctions membres qui fournissent une brève description de la fonctionnalité. Je prévois de reformuler la documentation de l'API Python afin de faciliter la compréhension de l'API et de clarifier ses fonctionnalités. J'ai également l'intention d'ajouter des liens vers les concepts de graphisme 3D pertinents utilisés dans différentes zones (par exemple, la matrice intrinsèque utilisée dans l'appareil photo).
Consultez la documentation sur l'API C++. Il n'existe actuellement pas de docstrings équivalentes dans la documentation C++, contrairement à la documentation Python. J'ai l'intention de documenter en détail les cours, ainsi que les fonctions et les membres des données qui leur sont associés .
Documents de haut et de bas niveau sur les structures de données principales. J'ai l'intention de comprendre le code de différentes structures de données telles que TriangleMesh, LineSet et Octree, et d'ajouter des commentaires dans le codebase, à la fois pour les nouveaux développeurs et pour tous les utilisateurs. Fournir une documentation de haut niveau sur l'utilisation et les concepts impliqués dans les structures en améliorant les tutoriels Je fournirai des exemples détaillés d'utilisation et j'ajouterai des liens pertinents vers les concepts impliqués dans les structures. Si le temps le permet, je travaillerai ensuite sur des tâches plus simples, comme documenter comment effectuer certaines tâches qui peuvent aider les nouveaux utilisateurs à s'associer au logiciel.
Calendrier du projet -
1er août – 1er septembre:
Faites connaissance avec mon mentor et discutez plus en détail du niveau de documentation requis dans les différentes parties du codebase. Étudiez également comment approfondir la documentation de bas niveau et de haut niveau. Je vais également passer ce temps à comprendre le codebase et à étudier les concepts afin de mieux les documenter.
Semaines 1 et 2:
Je vais mettre à jour et étendre le guide des contributeurs. J'améliorerai la documentation sur la façon de créer le code source. J'ajouterai également une section "Documenters" sur la façon dont les nouveaux contributeurs peuvent m'aider dans la documentation. Je vais également créer une vidéo YouTube expliquant les étapes à suivre pour créer le code source.
Semaines 3 - 5:
Je vais travailler sur l'extension de l'API Python. Reformuler la documentation existante et rédiger une documentation détaillée sur les membres existants. Je vais également ajouter des liens vers des concepts connexes afin que les utilisateurs puissent mieux se familiariser avec les concepts impliqués.
Semaines 6 - 8:
Les documents C++ actuels étant incomplets pour la plupart des parties de la bibliothèque, je passerai la plupart du temps à remplir les documents C++
Semaines 9 – 11:
Pendant cette période, je vais travailler sur les structures de données de base. Restructurez les tutoriels de chaque structure de données, fournissez une vue d'ensemble et documentez des exemples d'utilisation.
Dernière semaine:
Je vais utiliser la dernière semaine pour préparer mon rapport final sur les travaux effectués au cours de ma période de documentation de 12 semaines. Je prendrai également le temps d'examiner et de finaliser la documentation.