Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- Open3D
- Rédacteur technique:
- Rohan Rathi
- Nom du projet:
- Documentation technique de l'API Python et C++
- Durée du projet:
- Durée standard (trois mois)
Project description
Synopsis :
Le projet sera divisé en quatre parties : Mise à niveau et extension du guide du contributeur Open3D Documentation complète de l'API Python Documentation complète de l'API C++ Documentation de haut niveau sur les structures de données de base
Description :
Dans mon projet, je prévois de le diviser en quatre parties:
Je prévois de terminer et de mettre à jour le guide des contributeurs pour les nouveaux venus. Il s'agit d'un guide complet par étapes expliquant comment compiler le code source, créer la documentation et rejoindre la communauté des développeurs. En plus d'un guide écrit, je prévois de réaliser une vidéo expliquant précisément comment compiler le code source de la chaîne YouTube. Je vais également ajouter un guide expliquant comment les nouveaux développeurs peuvent contribuer à la documentation en apportant des modifications au code source compilé 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 rendre l'API plus facile à comprendre et de clarifier ses fonctionnalités. Je vais également ajouter des liens vers les concepts de graphismes 3D pertinents utilisés dans différents domaines (par exemple, la matrice intrinsèque utilisée dans la caméra).
Consultez la documentation de l'API C++. Actuellement, il n'existe pas de docstrings équivalents dans la documentation C++ par rapport à la documentation Python. J'ai l'intention de documenter en détail les classes ainsi que les fonctions de membre et membres de données qui leur sont associés .
Documents de haut et de bas niveau sur les principales structures de données Je souhaite comprendre le code de diverses structures de données telles que TriangleMesh, LineSet et Octree, et ajouter des commentaires dans le codebase, à la fois pour la compréhension des nouveaux développeurs et pour tous les utilisateurs. Nous avons également amélioré les tutoriels pour fournir une documentation de haut niveau sur l'utilisation et les concepts impliqués dans les structures. Je fournirai des exemples détaillés de son utilisation et 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'affilier au logiciel.
Calendrier du projet :
Du 1er août au 1er septembre:
Se familiariser avec mon mentor et discuter plus en détail du niveau de documentation requis dans différentes parties du codebase, et également de la profondeur à laquelle aller dans la documentation de bas niveau par rapport à celle de haut niveau. Je vais également passer ce temps à comprendre le codebase et à étudier les concepts afin de pouvoir les documenter plus efficacement.
Semaines 1 et 2:
Je vais mettre à jour et développer le guide des contributeurs. Je vais améliorer la documentation sur la compilation du code source. J'ajouterai également une section dédiée aux documentateurs expliquant comment les nouveaux contributeurs peuvent aider à la documentation. Je vais également créer une vidéo YouTube expliquant étape par étape comment compiler le code source.
Semaines 3 à 5:
Je vais m'occuper de l'extension de l'API Python. Réécrivez la documentation existante et rédigez une documentation détaillée des membres existants. J'ajouterai également des liens pertinents vers des concepts associés afin que les utilisateurs puissent mieux se familiariser avec les concepts concernés.
Semaines 6 à 8:
La plupart des documents C++ actuels sont incomplets. Je vais donc passer la plupart de mon temps à les compléter.
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 les détails d'utilisation des exemples.
Dernière semaine:
J'utiliserai la dernière semaine pour préparer mon rapport final sur le travail effectué au cours de la période de documentation de 12 semaines. Je vais également profiter de ce temps pour examiner et finaliser la documentation.