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:
- Tryton
- Technischer Redakteur:
- Dave
- Projektname:
- Dokumentation für Basismodule
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
In diesem Projekt schlage ich vor, die Dokumentation für die grundlegenden Tryton-Module zu lesen und zu aktualisieren. Dies sind die Module, die Nutzer am häufigsten aktivieren müssen, wenn sie ein Tryton-System einrichten.
Verbesserungen in der Moduldokumentation von Tryton helfen Nutzern, die richtigen Module für ihre Anforderungen zu finden und ihr System dann einzurichten und zu verwenden. 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 Module account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale und stock.
Es gibt drei Hauptzielgruppen für die Tryton-Dokumentation: Nutzer, Systemadministratoren und Entwickler. Um die Dokumentation auf diese Bereiche auszurichten, schlagen wir vor, dass die Dokumentation jedes Moduls im doc-Verzeichnis in separate Dateien aufgeteilt wird. Dazu gehören Dateien mit einem Inhaltsverzeichnis und einer Beschreibung des Moduls, Anweisungen zur Einrichtung des Moduls, Informationen zur Verwendung des Moduls sowie Details zum Design und Aufbau des Moduls. Je nach Funktionalität des Moduls sind einige dieser Dateien möglicherweise nicht erforderlich und es können bei Bedarf zusätzliche Dateien erstellt werden. Die Modulverbesserungen entsprechen denen, die ich bereits für das Partymodul vorgeschlagen habe: https://codereview.tryton.org/297241003/#ps327231002
Eine solche Strukturierung der Dokumentation wird gut funktionieren, da sie derzeit von Sphinx mithilfe von reStructuredText-Dateien generiert wird. Wenn ich Änderungen an der Dokumentation vornehme, werden sie auf die Website zur Codeüberprüfung von ausprobieren, damit sie überprüft und bei Bedarf aktualisiert werden können. Sobald alle zufrieden sind, können sie hoffentlich zur Aufnahme in Tryton zugelassen werden.