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 se divise en 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 compte compléter et mettre à jour le guide des contributeurs destiné aux nouveaux utilisateurs, qui fournit un guide par étapes complet sur la création du code source, la création de la documentation et la participation à la communauté des développeurs. En plus d'un guide écrit, je souhaite créer une vidéo présentant précisément les étapes à suivre pour créer le code source de la chaîne YouTube. Je vais également ajouter un guide sur la façon dont les nouveaux développeurs peuvent contribuer à la documentation en apportant des modifications au 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 description vague 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érents domaines (ex. : matrice intrinsèque utilisée dans l'appareil photo).
Complétez la documentation de l'API C++. Il n'existe actuellement pas de docstrings équivalentes dans la documentation C++ par rapport à la documentation Python. J'ai l'intention de décrire en détail les classes ainsi que les fonctions de membre associées et les membres de données .
Documents de haut et de bas niveau sur les principales structures de données. 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 liés aux structures en améliorant les tutoriels Je vous 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 la documentation sur la façon d’effectuer certaines tâches qui peuvent aider les nouveaux utilisateurs à s’affiner au logiciel.
Calendrier du projet -
1er août – 1er septembre:
Faire la connaissance de mon mentor et discuter plus en détail du niveau de documentation requis dans les différentes parties du codebase et de l'importance d'aller dans la documentation de bas niveau et de haut niveau. Je vais également consacrer ce temps à comprendre le codebase et à étudier les concepts afin de mieux les documenter.
Semaines 1 et 2:
Je vais mettre à jour et développer le guide des contributeurs. J'améliorerai la documentation sur la façon de créer le code source. J'ajouterai également une section documentaires sur la façon dont les nouveaux contributeurs peuvent aider dans la documentation. Je vais également créer une vidéo YouTube précisant les étapes à suivre pour créer le code source.
Semaines 3 - 5:
Je vais travailler à l'extension de l'API Python. Reformuler la documentation existante et rédiger une documentation détaillée sur les membres existants. J'ajouterai également des liens pertinents vers des concepts connexes afin que les utilisateurs puissent mieux se familiariser avec ceux-ci.
Semaines 6 – 8:
Les documents C++ actuels étant incomplets pour la plupart de la bibliothèque, je passerai la plupart du temps à les remplir
Semaines 9 – 11:
Pendant cette période, je vais travailler sur les principales structures de données. 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 le travail effectué au cours de ma période de documentation de 12 semaines. Je vais également prendre le temps d'examiner et de finaliser la documentation.