Αν και συχνά αγνοούνται από πολλούς χρήστες υπολογιστών, τα αρχεία βοήθειας παρέχουν βασικές πληροφορίες σχετικά με τον τρόπο χρήσης της εφαρμογής λογισμικού με την οποία σχετίζονται. Κάνοντας κλικ στη "Βοήθεια", ένας χρήστης μπορεί να λάβει μια επισκόπηση των δυνατοτήτων του προγράμματος, μια περιγραφή της οθόνης που κοιτάζει, οδηγίες για το πώς να χρησιμοποιήσει το πρόγραμμα για την εκτέλεση μιας συγκεκριμένης εργασίας ή να διαβάσει λίστες συχνών ερωτήσεων σχετικά με το πρόγραμμα και τις απαντήσεις τους. Η συγγραφή ενός αρχείου βοήθειας απαιτεί τόσο τη δυνατότητα εργασίας με εφαρμογές λογισμικού όσο και την ικανότητα να εξηγούν πράγματα με τρόπο που μπορούν να κατανοήσουν οι χρήστες.
Βήματα
Βήμα 1. Λάβετε ένα αντίγραφο του λογισμικού που πρόκειται να τεκμηριώσετε
Εάν είναι δυνατόν, θα πρέπει επίσης να λάβετε ένα αντίγραφο των γραπτών προδιαγραφών για το πρόγραμμα, αν και δεν συνεργάζονται όλοι οι προγραμματιστές λογισμικού μαζί τους. Σε ορισμένες περιπτώσεις, ο προγραμματιστής θα αποκλίνει από τις προδιαγραφές, με βάση τον σύντομο χρόνο ανάπτυξης ή την αδυναμία κωδικοποίησης μιας συγκεκριμένης δυνατότητας.
Βήμα 2. Αποκτήστε ένα εργαλείο συγγραφής βοήθειας
Παρόλο που είναι δυνατή η δημιουργία ενός αρχείου βοήθειας με το χέρι, χρησιμοποιώντας ένα αρχείο πλούσιας μορφής κειμένου (.rtf), οι περισσότεροι συντάκτες αρχείων βοήθειας χρησιμοποιούν μια εφαρμογή λογισμικού για να γράψουν τα αρχεία βοήθειας, όπως RoboHelp, Help and Manual, Doc-To -Βοήθεια, MadCap Flare ή HelpLogix. Τα περισσότερα εργαλεία συγγραφής βοήθειας περιλαμβάνουν επεξεργαστή κειμένου ή εργασία με πρόγραμμα επεξεργασίας κειμένου όπως το Microsoft Word και παρέχουν μια διεπαφή χρήστη που επιτρέπει στον συγγραφέα βοήθειας να δει πώς θα φαίνεται το αρχείο βοήθειας καθώς το γράφει ενώ γράφει κώδικα υπολογιστή στα παρασκήνια για να λειτουργήσει το αρχείο βοήθειας. Ορισμένα εργαλεία βοήθειας συγγραφής περιλαμβάνουν επίσης επεξεργαστές γραφικών για τη δημιουργία στιγμιότυπων οθόνης που θα συμπεριληφθούν στο αρχείο βοήθειας.
Υπάρχουν διάφορες μορφές αρχείων βοήθειας: Η πιο κοινή είναι η Βοήθεια HTML, η οποία χρησιμοποιείται από εφαρμογές που εκτελούνται στα Windows. (Μια παλαιότερη μορφή, το WinHelp, δεν υποστηρίζεται πλέον.) Η Apple και το Unix έχουν το καθένα τη δική του μορφή, όπως και η Sun Microsystems, με την JavaHelp. Οι εφαρμογές λογισμικού που έχουν σχεδιαστεί για να λειτουργούν με διάφορα λειτουργικά συστήματα ενδέχεται να χρησιμοποιούν σύστημα βοήθειας μεταξύ πλατφορμών που εκτελείται στο πρόγραμμα περιήγησης Web του χρήστη. Σε όποιο εργαλείο συγγραφής βοήθειας χρησιμοποιείτε θα πρέπει να υποστηρίζει τη μορφή (τις) βοήθειας στην οποία πρόκειται να δημιουργήσετε αρχεία βοήθειας
Βήμα 3. Δημιουργήστε το αρχείο έργου βοήθειας
Το εργαλείο συγγραφής βοήθειας θα δημιουργήσει ένα αρχείο έργου βοήθειας για εσάς, με βάση το όνομα αρχείου που παρέχετε και άλλες πληροφορίες. Το κύριο αρχείο έργου περιέχει πληροφορίες σχετικά με τα άλλα αρχεία, τα οποία περιλαμβάνουν ένα αρχείο περιεχομένου, ένα αρχείο ευρετηρίου, ένα ή περισσότερα αρχεία εικόνας και άλλα αρχεία.
- Το αρχείο περιεχομένου περιλαμβάνει το κείμενο στο αρχείο βοήθειας που εξηγεί πώς λειτουργεί η εφαρμογή λογισμικού που τεκμηριώνετε. Το κείμενο συνήθως χωρίζεται σε θέματα που καλύπτουν μια συγκεκριμένη οθόνη, λειτουργία ή διαδικασία.
- Το αρχείο ευρετηρίου είναι μια λίστα με τα θέματα του αρχείου βοήθειας. Χρησιμοποιείται για τη δημιουργία ενός πίνακα περιεχομένων που οι χρήστες μπορούν να χρησιμοποιήσουν για να επιλέξουν ένα θέμα για προβολή, καθώς και ένα ευρετήριο με δυνατότητα αναζήτησης στο αρχείο βοήθειας.
- Τα αρχεία εικόνας είναι γραφικά αρχεία οθονών προγράμματος ή τμήματα αυτών των οθονών που εμφανίζονται μέσα στο αρχείο βοήθειας για να ενισχύσουν την ικανότητα των χρηστών να κατανοήσουν σε τι αναφέρεται το κείμενο του αρχείου βοήθειας.
Βήμα 4. Προσαρμόστε το μέγεθος του παραθύρου βοήθειας
Αν δεν γράψετε το αρχείο βοήθειας για να εμφανιστεί στο πρόγραμμα περιήγησης Ιστού του χρήστη, το αρχείο βοήθειας θα εμφανιστεί στο δικό του παράθυρο. Το εργαλείο συγγραφής βοήθειας θα σας επιτρέψει να προσαρμόσετε τις οριζόντιες και κάθετες διαστάσεις του παραθύρου σε ένα μέγεθος που θα επιτρέψει στον τελικό χρήστη να διαβάσει το αρχείο βοήθειας χωρίς να παρεμποδίσει την ίδια την εφαρμογή. Το κύριο παράθυρο βοήθειας είναι συχνά σε μορφή τριών παραθύρων, με τον πίνακα περιεχομένων στα αριστερά και το επιλεγμένο θέμα στα δεξιά.
Τα αρχεία βοήθειας μπορούν επίσης να έχουν, εκτός από το κύριο παράθυρο, δευτερεύοντα παράθυρα που περιγράφουν λεπτομερώς μια συγκεκριμένη λειτουργία και αυτόματα μεγέθους αναδυόμενων παραθύρων που δίνουν σύντομες περιγραφές των χαρακτηριστικών. Τα αρχεία βοήθειας μπορούν επίσης να περιλαμβάνουν ενσωματωμένο κείμενο που εμφανίζεται μόνο όταν επισημαίνεται κείμενο ή γίνεται κλικ σε ένα κουμπί
Βήμα 5. Γράψτε τα θέματα βοήθειας
Για να γίνει αυτό, θα πρέπει να αναθεωρήσετε τις προδιαγραφές ή το ίδιο το πρόγραμμα για να δημιουργήσετε θέματα για την τεκμηρίωση των οθονών και των δυνατοτήτων του προγράμματος. Καθώς δημιουργείτε κάθε θέμα, το εργαλείο συγγραφής βοήθειας θα το προσθέσει στον πίνακα περιεχομένων και στο ευρετήριο του αρχείου βοήθειας.
- Ενώ μπορείτε να δημιουργήσετε τον πίνακα περιεχομένων καθώς προχωράτε, βοηθά να έχετε κάποιο σχέδιο για τον τρόπο οργάνωσης του. Μπορείτε να οργανώσετε τον πίνακα περιεχομένων γύρω από τις οθόνες του προγράμματος, τις δυνατότητές του, τους τρόπους χρήσης του ή κάποιο συνδυασμό αυτών.
- Καθώς γράφετε τα θέματα, λάβετε υπόψη άλλες πληροφορίες στο αρχείο βοήθειας στις οποίες οι χρήστες θα θέλουν να έχουν γρήγορη πρόσβαση. Μπορείτε να δημιουργήσετε άλματα ή υπερσυνδέσμους, στο κείμενο του αρχείου βοήθειας που συνδέονται με τα θέματα που περιέχουν αυτές τις πληροφορίες.
Βήμα 6. Συμπεριλάβετε στιγμιότυπα οθόνης, εάν χρειάζεται
Πολλές δυνατότητες προγράμματος εξηγούνται καλύτερα με συνδυασμό κειμένου και γραφικών. Μπορείτε να δημιουργήσετε στιγμιότυπα οθόνης είτε με την εφαρμογή που συνοδεύει το εργαλείο συγγραφής βοήθειας είτε με ξεχωριστή εφαρμογή, όπως το Microsoft Paint, το Paint Shop Pro ή το SnagIt.
- Το κείμενο και τα στιγμιότυπα οθόνης θα πρέπει να τοποθετηθούν μαζί σε ένα θέμα έτσι ώστε οι χρήστες να μπορούν να δουν το στιγμιότυπο οθόνης και το υποστηρικτικό του κείμενο χωρίς αδικαιολόγητη κύλιση. Σε πολλές περιπτώσεις, θα θέλετε να εμφανίσετε ένα μέρος της οθόνης προγράμματος αντί για ολόκληρη την οθόνη ή να εμφανίσετε το στιγμιότυπο οθόνης σε μικρότερο μέγεθος από το πρωτότυπο. Η εφαρμογή στιγμιότυπου οθόνης θα πρέπει να είναι ικανή να αλλάξει το μέγεθος του στιγμιότυπου οθόνης χωρίς θόλωση ή απώλεια λεπτομερειών.
- Εάν αναμένετε αλλαγές στη διεπαφή χρήστη μεταξύ της δοκιμαστικής και της τελικής έκδοσης του προγράμματος, ίσως θελήσετε να σταματήσετε τη δημιουργία στιγμιότυπων οθόνης μέχρι να έχετε την τελική έκδοση του προγράμματος προς εργασία.
Βήμα 7. Δημιουργήστε ένα αρχείο χάρτη, εάν χρειάζεται
Ορισμένα προγράμματα περιλαμβάνουν κουμπιά "Βοήθεια" για να κάνει κλικ ο χρήστης και να εμφανίσει το θέμα στο αρχείο βοήθειας που περιγράφει συγκεκριμένα τον τρόπο λειτουργίας αυτής της οθόνης. Η εμφάνιση ενός θέματος με αυτόν τον τρόπο ονομάζεται βοήθεια ευαίσθητη στο πλαίσιο και απαιτεί τη δημιουργία ενός αρχείου χάρτη για τον προγραμματιστή για τη σύνδεση του κουμπιού "Βοήθεια" με το συγκεκριμένο θέμα στο αρχείο βοήθειας. Το εργαλείο συγγραφής βοήθειας μπορεί να δημιουργήσει ένα για εσάς ή ο προγραμματιστής μπορεί να το κωδικοποιήσει και να σας το δώσει για να το συμπεριλάβετε στο αρχείο βοήθειας.
Βήμα 8. Συγκεντρώστε το αρχείο βοήθειας
Η μεταγλώττιση δημιουργεί το πραγματικό αρχείο βοήθειας που θα συμπεριληφθεί στο πρόγραμμα. Για τις περισσότερες μορφές βοήθειας, αυτό θα ενσωματώσει όλα τα συστατικά αρχεία που δημιουργήθηκαν κατά τη δημιουργία του αρχείου βοήθειας, αν και ορισμένες μη μεταγλωττισμένες μορφές βοήθειας απαιτούν επίσης να συμπεριληφθούν μεμονωμένα αρχεία θεμάτων βοήθειας στο πρόγραμμα.
Βήμα 9. Δοκιμάστε το αρχείο βοήθειας
Μόλις καταρτίσετε το αρχείο βοήθειας, πρέπει να το δοκιμάσετε για να βεβαιωθείτε ότι όλοι οι υπερσύνδεσμοι συνδέονται με τα θέματα στα οποία υποτίθεται ότι εμφανίζονται σωστά και όλα τα γραφικά. Το αρχείο βοήθειας πρέπει επίσης να δοκιμαστεί για να διασφαλιστεί ότι το περιεχόμενο είναι ακριβές και κατάλληλο για τους χρήστες και σε συνεπή μορφή. Θα θέλετε να ελέγξετε μόνοι σας το αρχείο βοήθειας και να ζητήσετε από τους ανθρώπους που δοκιμάζουν την εφαρμογή να το ελέγξουν επίσης.
Σε μεγαλύτερα έργα αρχείων βοήθειας, η σύνταξη και ο έλεγχος είναι συνεχείς διαδικασίες. Θα θελήσετε να μεταγλωττίσετε το αρχείο βοήθειας και να ελέγξετε την εργασία σας αρκετές φορές πριν δημιουργήσετε την τελική έκδοση
Βήμα 10. Δώστε το αρχείο βοήθειας στον προγραμματιστή για να το συμπεριλάβει στο πρόγραμμα
Ανάλογα με τη φύση του έργου και τη μορφή αρχείου βοήθειας, ίσως χρειαστεί να παράσχετε στον προγραμματιστή πολλά αρχεία, συμπεριλαμβανομένου ενός αρχείου χάρτη, εάν υπάρχουν θέματα ευαίσθητα στο περιβάλλον.
