Συχνά γεμάτη με ορολογία, ακρωνύμια και οδηγίες που απαιτούν διδακτορικό για να κατανοήσουν, τα εγχειρίδια χρήσης λογισμικού γράφονται μερικές φορές από την άποψη ενός προγραμματιστή παρά ενός χρήστη. Ως αποτέλεσμα, ο οδηγός μπορεί να κάνει υποθέσεις σχετικά με το επίπεδο δεξιοτήτων του αναγνώστη που είναι συχνά λανθασμένες. Το πρώτο βήμα στο γράψιμο ενός καλού εγχειριδίου χρήσης είναι να αποκτήσετε την πραγματική διαδικασία γραφής όσο το δυνατόν πιο μακριά από τους μηχανικούς.
Ο προγραμματιστής λογισμικού γνωρίζει περισσότερο από οποιονδήποτε τι κάνει το λογισμικό, αλλά αυτό δεν σημαίνει ότι ο προγραμματιστής πρέπει να γράψει τον οδηγό. Αντιθέτως, πρόκειται για ένα ξεχωριστό μειονέκτημα. Πιο σημαντικό από μια βαθιά κατανόηση της εσωτερικής λειτουργίας του λογισμικού είναι η κατανόηση του ποιος θα είναι ο τελικός χρήστης, του εκπαιδευτικού του επιπέδου και του τρόπου με τον οποίο ο τελικός χρήστης θα χρησιμοποιεί το λογισμικό. Στις περισσότερες περιπτώσεις, οι τελικοί χρήστες δεν χρειάζεται να γνωρίζουν τα καλύτερα σημεία προγραμματισμού και τις λειτουργίες back-end του λογισμικού - απλά πρέπει να ξέρουν πώς να το χρησιμοποιήσουν για να διευκολύνουν τη δουλειά τους.
Δοκιμή χρηστών
Το εγχειρίδιο χρήσης θα πρέπει να είναι σε μεγάλο βαθμό προσανατολισμένο προς την εργασία, και όχι σε μεγάλο βαθμό περιγραφικό. Επειδή το εγχειρίδιο είναι γραμμένο για να βοηθήσει τους χρήστες να κατανοήσουν πώς να εκτελέσουν συγκεκριμένες εργασίες, ο συγγραφέας πρέπει να έχει κατανόηση και αυτών των εργασιών, και ως εκ τούτου, είναι απαραίτητη η μετάβαση σε κάθε ξεχωριστό βήμα κάθε χαρακτηριστικού. Δεν είναι απαραίτητο για τον συγγραφέα να γνωρίζει κατ 'ανάγκη πώς δημιουργήθηκε το πρόγραμμα από άποψη σχεδιασμού ή εξέλιξης, αλλά είναι απαραίτητο να έχουμε μια ισχυρή εργασιακή γνώση όλων των χαρακτηριστικών του. Ενώ εκτελείτε κάθε εργασία, αφιερώστε χρόνο για να γράψετε κάθε βήμα, συμπεριλαμβανομένων των κλικ, αναπτυσσόμενων μενού και άλλων ενεργειών.
Η Διαδικασία Συνέντευξης
Παρόλο που ο κύριος του έργου δεν πρέπει να είναι αυτός που θα γράψει το εγχειρίδιο, θα είναι ακόμα ένας πολύτιμος πόρος για τον συγγραφέα και προτού αρχίσει η γραφή, σχεδιάστε μια συνάντηση kickoff μεταξύ του συγγραφέα, προγραμματιστή και μηχανικών και δυνητικούς τελικούς χρήστες για να ενημερώσετε έργο του συγγραφέα από την αρχή. Θα πρέπει να καταγράφονται συνεντεύξεις με εμπειρογνώμονες και μηχανικούς, με μεταγραφές που θα γίνουν αργότερα.
Εικόνες
Ένα εγχειρίδιο χρήσης δεν πρέπει να είναι πολύ βαρύ για το κείμενο. Αντίθετα, ενσωματώστε τη φιλελεύθερη χρήση γραφικών και κλιπ οθόνης. Η περιγραφή μιας ενέργειας είναι πολύ πιο ξεκάθαρη με οδηγίες που βασίζονται σε κείμενο και συνοδεύονται από ένα κλιπ οθόνης που σαφώς απεικονίζει αυτή την κατεύθυνση. Συμπεριλάβετε τις προβολές πριν και μετά, για να δείξετε την εμφάνιση της οθόνης πριν από τη λήψη κάθε ενέργειας και τι συμβαίνει μετά τη λήψη της ενέργειας. Ένα απλό βοηθητικό πρόγραμμα λήψης οθόνης, όπως το Εργαλείο αποκοπής που περιλαμβάνεται στα Microsoft Windows, λειτουργεί καλά για τη λήψη αυτών των εικόνων. Φροντίστε να αριθμήσετε κάθε εικόνα και να συμπεριλάβετε μια λεζάντα που περιγράφει σε σύντομο χρονικό διάστημα. Το κεντράρετε αμέσως κάτω από την παράγραφο που εισάγει πρώτα την έννοια που απεικονίζεται στην εικόνα.
Μορφοποίηση
Η σαφής επικοινωνία σε ένα τεχνικό έγγραφο απαιτεί σχεδιασμό και προσεκτική τήρηση των προτύπων σε ολόκληρο τον οδηγό. Τα πρότυπα στην παρουσίαση, τη γλώσσα και την ονοματολογία συμβάλλουν στην αποφυγή σύγχυσης. Τα πρότυπα είναι διαθέσιμα και μπορούν να αποτελέσουν ένα καλό σημείο εκκίνησης για ομοιομορφία, παρόλο που αυτά μπορούν βεβαίως να προσαρμοστούν ώστε να ταιριάζουν σε κάθε κατάσταση. Χρησιμοποιώντας περιθώριο ενός ίντσας με μία στήλη, ταιριάζει καλύτερα στην ανάγκη προσθήκης γραφικών. μια ρύθμιση με δύο στήλες μπορεί να φαίνεται υπερβολικά γεμάτη και μπορεί να προκαλέσει σύγχυση των εικόνων.
Έκδοση και παρακολούθηση
Περισσότερο από κάθε άλλο είδος εγγράφου, ένας οδηγός χρήσης λογισμικού ενδέχεται να περάσει από πολλές επαναλήψεις πριν ολοκληρωθεί και είναι πιθανό να περάσει από μια διαδικασία επανεξέτασης από πολλούς ενδιαφερόμενους. Η χρήση της δυνατότητας "Αλλαγές παρακολούθησης" στο Microsoft Word είναι ένας εύκολος τρόπος για να παρακολουθείτε τα σχόλια και τις αλλαγές κάθε ατόμου. Η δημιουργία πολλαπλών εκδόσεων μετά από κάθε κύκλο επανεξέτασης, καθένα με διαφορετικό όνομα αρχείου, βοηθά επίσης τη διαδικασία και εξασφαλίζει ότι όλοι οι ενδιαφερόμενοι είναι ικανοποιημένοι με το τελικό αποτέλεσμα.
