Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Tryton
- Technischer Redakteur:
- David
- Projektname:
- Dokumentation zu Basismodulen
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
In diesem Projekt möchte ich die Dokumentation für die grundlegenden Tryton-Module überprüfen und aktualisieren. Dies sind die Module, die Nutzer am häufigsten aktivieren müssen, wenn sie ein Tryton-System einrichten.
Verbesserungen an der Moduldokumentation von Tryton helfen Nutzern, die richtigen Module für ihre Anforderungen zu finden und ihnen dann bei der Einrichtung und Verwendung ihres Systems zu helfen. Eine gute Moduldokumentation ermöglicht es Nutzern, Antworten auf einige ihrer grundlegenden Fragen zu finden, ohne auf Antworten im Diskussionsforum warten zu müssen.
Die grundlegenden Module umfassen mindestens die folgenden: „account“, „account_invoice“, „account_invoice_stock“, „account_product“, „company“, „country“, „currency“, „party“, „product“, „purchase“, „sale“ und „stock“.
Die Tryton-Dokumentation richtet sich hauptsächlich an drei Zielgruppen: Nutzer, Systemadministratoren und Entwickler. Um die Dokumentation auf jede dieser Gruppen auszurichten, schlage ich vor, dass die Dokumentation jedes Moduls in separate Dateien im doc-Verzeichnis aufgeteilt wird. Dazu gehören Dateien mit einem Inhaltsverzeichnis und einer Beschreibung des Moduls, eine Anleitung zum Einrichten des Moduls, Informationen zur Verwendung des Moduls und Details zum Design und zur Struktur des Moduls. Je nach Funktion des Moduls sind einige dieser Dateien möglicherweise nicht erforderlich. Bei Bedarf können zusätzliche Dateien erstellt werden. Die Verbesserungen am Modul werden in der Art und Weise erfolgen, wie ich sie bereits für das Parteimodul vorgeschlagen habe: https://codereview.tryton.org/297241003/#ps327231002
Eine solche Strukturierung der Dokumentation ist sinnvoll, da die Dokumentation derzeit von Sphinx mithilfe von reStructuredText-Dateien generiert wird. Wenn ich Änderungen an der Dokumentation vornehme, werden diese auf die Website für die Test-Code-Prüfung hochgeladen, damit sie überprüft werden können. Ich kann sie dann bei Bedarf aktualisieren. Sobald alle mit ihnen zufrieden sind, können sie hoffentlich für die Aufnahme in Tryton genehmigt werden.