Dokumentation
Alle Anwendungen sollten Dokumentation zur Verfügung stellen, um Ihren Benutzern beim Verstehen der Anwendung zu helfen und sie bei der Lösung von Problemen zu unterstützen. Zwar erfordert eine Anwendung nicht unbedingt das Lesen der Dokumentation vor der Benutzung, aber eine Dokumentation kann doch ein bedeutsames Werzeug für Benutzer sein, insbesondere für sehr komplexe Anwendungen.
GNOME bietet eine vereinheitlichte Umgebung zur Bereitstellung von Benutzerdokumentation. Sie können Dokumentation im als Industriestandard üblichen DocBook-Format anbieten. Die Verwendung von DocBook vermeidet, dass Sie sich mit Formatierungsdetails befassen müssen. Ihre Dokumentation wird automatisch formatiert, mit den gleichen konsistenten Konventionen wie die übrige Systemdokumentation.
Yelp, der Hilfebetrachter von GNOME, zeigt Dokumentationen an und ermöglicht Ihnen auch, diese auszudrucken. Eine Auflistung aller Dokumentationen des Systems wird zur Verfügung gestellt, die die Volltextsuche innerhalb der gesamten Dokumentation ermöglicht. Das GNOME-Hilfesystem bietet alle diese Funktionsmerkmale frei verfügbar an.
Weitere Informationen über das Schreiben von Dokumentation für Ihre Anwendung finden Sie im GNOME Handbook of Writing Software Documentation, DocBook: The Definitive Guide, und dem GNOME Documentation Style Guide.