Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Die GNOME Foundation
- Technischer Redakteur:
- Wise4rmGod
- Projektname:
- Konsolidierung der GObject-Anleitung
- Projektlänge:
- Lang andauernd (5 Monate)
Projektbeschreibung
Die Dokumentation zum GLib-Objekttypsystem enthält einen Überblick über das Typsystem und die Basisobjektklasse. Sie deckt Themen wie die Lebensdauer einer Objektinstanz, die Installation von Eigenschaften, Schnittstellen und Best Practices zum Schreiben von Objekttypen ab. Außerdem gibt es ein Tutorial, in dem ähnliche Themen auf narrativere Weise behandelt werden. Idealerweise sollten wir nur eine Anleitung zu allen Themen sowie eine spezielle, ausführliche Dokumentation für die komplexeren Aspekte der API haben. Der Abschnitt zu den grundlegenden Konzepten sollte mit dem Abschnitt zur Anleitung zusammengeführt werden. Verwenden Sie dazu Beispiele aus dem Abschnitt zur Anleitung und eine erzählendere Sprache.