Τεκμηρίωση

Όλες οι εφαρμογές πρέπει να παρέχουν τεκμηρίωση, για να επιτρέπουν στους χρήστες να κατανοούν την εφαρμογή και να επιλύουν τυχόν προβλήματα. Αν και δεν θα έπρεπε να απαιτείται η ανάγνωση της τεκμηρίωσης πριν τη χρήση μιας καλοσχεδιασμένης εφαρμογής, η τεκμηρίωση μπορεί να αποτελέσει σημαντικό εργαλείο στα χέρια του χρήστη, ιδίως αν πρόκειται για περίπλοκες εφαρμογές.

Το GNOME παρέχει ένα ενιαίο πλαίσιο για την παροχή τεκμηρίωσης χρήστη. Μπορείτε να παρέχετε τεκμηρίωση χρησιμοποιώντας το βιομηχανικό πρότυπο DocBook. Η χρήση του DocBook σας απαλλάσσει από το άγχος της μορφοποίησης, καθώς η τεκμηρίωσή σας μορφοποιείται αυτόματα, ακολουθώντας τις ίδιες συμβάσεις με την υπόλοιπη τεκμηρίωση του συστήματος.

Η εφαρμογή βοήθειας του GNOME, το Yelp, προβάλλει και εκτυπώνει την τεκμηρίωση, παρέχει έναν κατάλογο όλης της τεκμηρίωσης του συστήματος, και επιτρέπει στο χρήστη να κάνει αναζήτηση στο πλήρες κείμενο όλων των εγγράφων τεκμηρίωσης. Όλες αυτές οι λειτουργίες σας παρέχονται ελεύθερα, εφόσον χρησιμοποιείτε το σύστημα βοήθειας του GNOME.

Για περισσότερες πληροφορίες σχετικά με τη συγγραφή τεκμηρίωσης για την εφαρμογή σας, δείτε τα GNOME Handbook of Writing Software Documentation, DocBook: The Definitive Guide, και GNOME Documentation Style Guide.