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:
- Die GNOME Foundation
- Technischer Redakteur:
- Wise4rmGod
- Projektname:
- Konsolidierung der GObject-Anleitung
- Projektdauer:
- Langfristig (5 Monate)
Projektbeschreibung
Die Dokumentation zum GLib-Objekttypsystem enthält einen Überblick über das Typsystem und die Basisobjektklasse. Die Themen reichen von der Lebensdauer einer Objektinstanz über die Installation von Eigenschaften über Schnittstellen bis hin zu Best Practices zum Schreiben von Objekttypen sowie ein Tutorial, das ähnliche Themen erzählerisch behandelt. Idealerweise sollten wir nur eine Anleitung zu allen Themen sowie eine spezifische, ausführliche Dokumentation für die komplexeren Aspekte der API haben. Der Abschnitt mit den Basiskonzepten sollte mit dem Abschnitt mit der Anleitung zusammengeführt werden, indem im ersten Abschnitt Beispiele und eine erzählerischere Sprache aus dem zweiten verwendet werden.