Επόμενο Προηγούμενο Περιεχόμενα
Αν η εφαρμογή που γράφετε έχει γραφικό μέρος και ανήκει
σε κάποιο από τα δύο γνωστά περιβάλλοντα εφαρμογών
(desktop environments), δεν χρειάζεται να συνεχίσετε την
ανάγνωση. Απλά δείτε τις αντίστοιχες σελίδες που εξηγούν
πως πρέπει να είναι το documentation της εφαρμογής σας.
Λογικά θα πρέπει να γράψετε ένα αρχείο SGML Docbook το
οποίο θα πρέπει να έχει μια συγκεκριμένη μορφή.
Αν η εφαρμογή σας είναι απλά γραφική και δεν υπάρχει
"σωστός" τρόπος για την εισαγωγή βοήθειας, προτιμήστε το
δοκιμασμένο Latex. Βάζετε το output σε html στο site του
προγράμματος για online αναζήτηση, ενώ μαζί με το ίδιο το
πρόγραμμα ενσωματώνετε τα ps και pdf αρχεία. Αυτό είναι
απλά μία πρόταση. Είναι στην κρίση σας να επιλέξετε.
Εδώ θα μιλήσουμε για την περίπτωση όπου το πρόγραμμα σας
δεν έχει γραφικό περιβάλλον, αλλά εκτελείται σε
περιβάλλον γραμμής εντολών. Αν είναι πολύ απλό στην
χρήση, και με λίγες παραμέτρους τα πράγματα είναι εύκολα.
Απλά βάλτε στο -h/--help του να εμφανίζεται κάθε δυνατή
παράμετρος με μία μικρή εξήγηση. Σε αυτήν την περίπτωση
μπορείτε να ακολουθήσετε και το GNU style για τις
παραμέτρους όπου κάθε μία έχει ένα σύντομο όνομα για τους
έμπειρους χρήστες (πχ -b) και ένα πιο μεγάλο για τους
αρχάριους (πχ --buffer-size).
Αν όμως δεν ισχύει κάτι τέτοιο οφείλετε να δώσετε
ξεχωριστό documentation. Αυτό θα βοηθήσει τόσο τους
έμπειρους χρήστες όταν θα θελήσουν να "ξεζουμίσουν" το
πρόγραμμα σας, αλλά και τους αρχάριους που αρέσκονται στο
να βρίσκουν κάπου "μαζεμένη" την βοήθεια ενός
προγράμματος.
Επόμενο Προηγούμενο Περιεχόμενα
