Τα 4 είδη της τεκμηρίωσης και εσυ

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

Τα είδη της τεκμηρίωσης

Για να έχεις καλή τεκμηρίωση θα πρέπει να έχεις 4 διαφορετικά είδη για διαφορετικές χρήσεις

  • Tutorials από κάπου θα πρέπει να ξεκινήσεις να μαθαίνεις για κάτι. Να ακολουθήσεις κάποιες οδηγίες βήμα βήμα και να ξεκινήσεις να μαθαίνεις κάτι
  • HOW-TΟ Το επόμενο βήμα, είναι οδηγίες για να λύσεις ένα συγκεκριμένο πρόβλημα, που μπορεί να περιλαμβάνει χρήσεις περισσότερων από ένα λογισμικών.
  • Explaination Το επόμενο βήμα στην κατανόηση. Για ποιο λόγο το σύστημα έχει σχεδιαστεί με αυτόν τον τρόπο; Ποια προβλήματα καλείτε να λύσει; Τι περιορισμοί υπάρχουν;
  • Reference Συνήθως αυτό παίρνουμε στην καλύτερη περίπτωση. Αναλυτικές εξηγήσεις τι κάνει κάθε επιλογή, συχνά με πολλές άγνωστες λέξεις.

Μπορείς να βοηθήσεις

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

Εδώ μπορείς να βοηθήσεις! Έλυσες κάποιο πρόβλημα, βρήκες κάποιο ωραίο λογισμικό; Γράψε ένα μικρό σημείωμα, κάποιο άρθρο η κάποιον οδηγό στο linux-user.gr. Δεν είναι ανάγκη να είναι τέλειο, κάθε αρχή και δύσκολη. Δεν είναι ανάγκη να είναι σωστό, αν κάνεις κάποιο λάθος, αν κατάλαβες κάτι στραβά, αν υπάρχει κάποια καλύτερη λύση, ε τότε θα σε διορθώσει κάποιος άλλος. Κανένας εδώ δεν θα σε πει άσχετο ή άχρηστο. Εκτιμάμε την γνώση που μας παρέχετε από άτομα σαν εμάς.

Να σου πω και ένα μυστικό; Αν θέλεις να μάθεις καλά κάτι, γράψε για αυτό. Θα το καταλάβεις καλύτερα στην προσπάθεια σου να το εξηγήσεις σε άλλους. Και θα έχεις και την ηθική ικανοποίηση πως βοήθησες κάποιον. Και αν κάνεις κάτι λάθος και σε διορθώσουν πρέπει να το βλέπεις με χαρά, έμαθες κάτι παραπάνω.

Μην είσαι ντροπιάρης, μπορείς να το κάνεις, όσο λίγες και να είναι οι γνώσεις που νομίζεις πως έχεις. Περιμένουμε λοιπόν να δούμε τον επόμενο οδηγό σου, την επόμενη παρουσίαση ενός προγράμματος ή μιας διανομής που σου άρεσε.

Πηγή:

5 «Μου αρέσει»