Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Open3D
- Technischer Redakteur:
- Rohan Rathi
- Projektname:
- Technische Dokumentation zu Python und C++ API
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Synopse:
Das Projekt besteht aus vier Teilen: Führen Sie ein Upgrade und Erweiterung des Leitfadens des Open3D-Mitwirkenden durch. Vollständige Python-API-Dokumentation Vollständige C++ API-Dokumentation Übersichtliche Dokumentation zu wichtigen Datenstrukturen
Beschreibung:
In meinem Projekt plane ich, das Projekt in 4 Teile zu unterteilen:
Ich habe vor, den Leitfaden für neue Nutzer zu vervollständigen und zu aktualisieren. Dieser enthält eine umfassende Schritt-für-Schritt-Anleitung zum Erstellen des Quellcodes, zum Erstellen der Dokumentation und zum Beitritt zur Entwickler-Community. Zusätzlich zu einer schriftlichen Anleitung möchte ich ein Video erstellen, in dem die genauen Schritte zum Erstellen des Quellcodes für den YouTube-Kanal beschrieben werden. Ich werde auch eine Anleitung hinzufügen, wie neue Entwickler zur Dokumentation beitragen können, indem sie Änderungen am Quellcode vornehmen, der von Sphinx mit pybind und doxygen erstellt wurde.
Python API-Dokumentation erweitern Derzeit enthält das Python-API grundlegende docstrings für die Klassen und Member-Funktionen, die eine vage Beschreibung der Funktionalität liefern. Ich habe vor, die Dokumentation zur Python API umzuformulieren, damit die API besser verständlich und die Funktionalität klarer wird. Ich habe auch vor, Links zu relevanten 3D-Grafikkonzepten hinzuzufügen, die in verschiedenen Bereichen verwendet werden (z. B. intrinsische Matrix in der Kamera).
Befolgen Sie die Dokumentation zur C++ API. Derzeit gibt es in der C++-Dokumentation keine äquivalente docstrings im Vergleich zur Python-Dokumentation. Ich habe vor, die Kurse und die zugehörigen Mitgliederfunktionen und Datenmitglieder detailliert zu dokumentieren .
Übergeordnete und untergeordnete Dokumente der Kerndatenstrukturen. Ich beabsichtige, den Code verschiedener Datenstrukturen wie TriangleMesh, LineSet und Octree zu verstehen und Kommentare in der Codebasis hinzuzufügen, sowohl für neue Entwickler als auch für Nutzende. sowie eine allgemeine Dokumentation zur Nutzung und zu den Konzepten der Strukturen bereitstellen, indem Sie die Anleitungen verbessern. Ich werde detaillierte Beispiele für die Verwendung angeben und relevante Links zu den Konzepten der Strukturen hinzufügen. Wenn es die Zeit erlaubt, werde ich an einfacheren Aufgaben arbeiten, z. B. an der Dokumentation bestimmter Aufgaben, die neuen Nutzern helfen können, eine Verbindung zur Software herzustellen.
Projektzeitplan-
1. August–1. September:
Machen Sie sich mit meinem Mentor vertraut und besprechen Sie den Umfang der Dokumentation, die in verschiedenen Teilen der Codebasis erforderlich ist, und erläutern Sie, wie detailliert die Low-Level- im Vergleich zu High-Level-Dokumentation aussehen sollte. Außerdem werde ich diese Zeit damit verbringen, die Codebasis zu verstehen und die Konzepte zu studieren, damit ich sie besser dokumentieren kann.
Woche 1 und 2:
Ich werde den Leitfaden für Beitragende aktualisieren und erweitern. Ich werde die Dokumentation zum Erstellen des Quellcodes verbessern. Ich werde auch einen Abschnitt für Dokumentationen hinzufügen, in dem beschrieben wird, wie neue Beitragende bei der Dokumentation helfen können. Ich werde auch ein YouTube-Video erstellen, in dem Schritt für Schritt erklärt wird, wie der Quellcode erstellt wird.
Woche 3–5:
Ich werde daran arbeiten, die Python API zu erweitern. Formulieren Sie die vorhandene Dokumentation um und schreiben Sie eine detaillierte Dokumentation der vorhandenen Mitglieder. Außerdem werde ich relevante Links zu verwandten Konzepten hinzufügen, damit die Nutzenden sich besser mit den Konzepten vertraut machen können.
Woche 6–8:
Die aktuellen C++-Dokumente sind für einen Großteil der Bibliothek unvollständig, sodass ich die meiste Zeit damit verbringen werde, die C++-Dokumente auszufüllen.
Woche 9–11:
In dieser Zeit werde ich an den zentralen Datenstrukturen arbeiten. Strukturieren Sie die Anleitungen der einzelnen Datenstrukturen neu, geben Sie einen allgemeinen Überblick und dokumentieren Sie Beispielnutzungsdetails.
Letzte Woche:
Ich werde die letzte Woche nutzen, um meinen Abschlussbericht über die Arbeiten zu erstellen, die während meiner 12-wöchigen Dokumentationsphase geleistet wurden. Außerdem werde ich die Zeit damit verbringen, die Dokumentation zu prüfen und fertigzustellen.