Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel 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: Upgrade und Erweiterung des Leitfadens für Open3D-Beitragende Vollständige Python API-Dokumentation Vollständige C++ API-Dokumentation Übersicht über die wichtigsten Datenstrukturen
Beschreibung:
In meinem Projekt habe ich vor, das Projekt in vier Teile zu unterteilen:
Ich habe vor, den Leitfaden für Beitragende für Neueinsteiger fertigzustellen und zu aktualisieren. Er 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 einem schriftlichen Leitfaden möchte ich ein Video erstellen, in dem die genauen Schritte zur Erstellung 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.
Erweitern Sie die Dokumentation zur Python API. 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 Python API-Dokumentation umzuformulieren, damit die API besser verständlich und die Funktionalität klarer wird. Ich möchte auch Links zu relevanten 3D-Grafikkonzepten hinzufügen, die in verschiedenen Bereichen verwendet werden (z. B. intrinsische Matrix in der Kamera).
Arbeiten Sie die Dokumentation zur C++ API aus. Derzeit gibt es in der C++-Dokumentation keine entsprechenden docstrings im Vergleich zur Python-Dokumentation. Ich habe vor, die Klassen und die zugehörigen Elementfunktionen und Datenelemente detailliert zu dokumentieren .
Übersichtliche und Low-Level-Dokumente der wichtigsten Datenstrukturen. Ich habe vor, den Code verschiedener Datenstrukturen wie TriangleMesh, LineSet und Octree zu verstehen und Kommentare in der Codebasis hinzuzufügen, um sowohl neue Entwickler als auch andere Nutzer zu verstehen. Außerdem wird durch die Verbesserung der Anleitungen eine allgemeine Dokumentation zur Nutzung und zu den Konzepten der Strukturen bereitgestellt. Ich werde detaillierte Beispiele für die Verwendung nennen und relevante Links zu den Konzepten der Strukturen hinzufügen. Wenn es die Zeit erlaubt, übernehme ich die einfacheren Aufgaben, z. B. die Dokumentation zur Durchführung bestimmter Aufgaben, die neuen Nutzern helfen können, eine Verbindung zu der Software herzustellen.
Projektzeitplan-
1. August–1. September:
Lerne meinen Mentor kennen und erkläre, welche Dokumentation in verschiedenen Teilen der Codebasis erforderlich ist. Erläutere auch, wie detailliert die Low-Level- im Vergleich zur High-Level-Dokumentation aussehen sollte. Außerdem werde ich diese Zeit damit verbringen, die Codebasis zu verstehen und die Konzepte zu lernen, 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 Dokumentarbereich hinzufügen, in dem es darum geht, wie neue Beitragende bei der Dokumentation helfen können. Ich werde auch ein YouTube-Video erstellen, in dem Sie Schritt für Schritt angeben, 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 füge ich relevante Links zu verwandten Konzepten hinzu, damit die Nutzer sich besser mit den behandelten Konzepten vertraut machen können.
Woche 6–8:
Die aktuellen C++-Dokumente sind größtenteils 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 grundlegenden Datenstrukturen arbeiten. Strukturieren Sie die Anleitungen jeder Datenstruktur neu, geben Sie einen allgemeinen Überblick und dokumentieren Sie Beispiele für die Nutzungsdetails.
Letzte Woche:
In der letzten Woche erstelle ich meinen Abschlussbericht über die Arbeit, die ich während der 12-wöchigen Dokumentationsphase geleistet habe. Außerdem werde ich diese Zeit damit verbringen, die Dokumentation zu prüfen und fertigzustellen.