Γράψτε ένα εγχειρίδιο χρήστη

Συγγραφέας: John Pratt
Ημερομηνία Δημιουργίας: 15 Φεβρουάριος 2021
Ημερομηνία Ενημέρωσης: 1 Ιούλιος 2024
Anonim
Bubbl.us - Εγχειρίδιο χρήσης
Βίντεο: Bubbl.us - Εγχειρίδιο χρήσης

Περιεχόμενο

Το λογισμικό, οι υπολογιστές, τα παιχνίδια και οι συσκευές απαιτούν εγχειρίδια χρήστη. οδηγοί που εξηγούν πώς να χρησιμοποιήσετε το προϊόν (και πώς να μην το κάνετε). Ένα εγχειρίδιο χρήστη είναι ένα επίσημο έγγραφο με συγκεκριμένη δομή και πρέπει να είναι γραμμένο από κάποιον που γνωρίζει το προϊόν από έξω, όπως ένας τεχνικός συγγραφέας ή ο σχεδιαστής του προϊόντος. Για τη σύνταξη ενός αποτελεσματικού εγχειριδίου χρήστη απαιτείται να γνωρίζετε ποιος θα χρησιμοποιήσει το προϊόν και ότι θα συντάξετε το εγχειρίδιο λαμβάνοντας υπόψη αυτούς τους χρήστες. Διατηρήστε το γράψιμό σας σαφές, ακριβές και απλό για να εξασφαλίσετε μια εμπειρία χρήστη χωρίς προβλήματα.

Για να πας

Μέρος 1 από 4: Σχεδιασμός του εγχειριδίου του ιδιοκτήτη σας

  1. Κάντε μια ανάλυση χρήστη. Το εγχειρίδιο χρήσης πρέπει να είναι γραμμένο για τους χρήστες - όσοι θα αγοράσουν το προϊόν ή την υπηρεσία σας και θα διαβάσουν το εγχειρίδιο χρήστη. Μια ανάλυση χρήστη θα σας πει ποιος θα είναι το κύριο ή το κοινό-στόχο σας και θα σας καθοδηγήσει στη σύνταξη του κειμένου.
    • Μιλήστε με άτομα που θα χρησιμοποιούν τη συσκευή σας. Προσφέρετε στους δοκιμαστικούς χρήστες πρωτότυπα της συσκευής και πρόχειρο εγχειρίδιο χρήστη υπό ελεγχόμενες συνθήκες. Ζητήστε από αυτούς τους δοκιμαστικούς χρήστες να σχολιάσουν πράγματα που είναι ασαφή ή μπερδεμένα στον οδηγό χρήσης και κάντε αλλαγές στον οδηγό χρήστη με βάση αυτά τα σχόλια.
    • Δεν μπορείτε ποτέ να ικανοποιήσετε ολόκληρο το κοινό σας. γράψτε το εγχειρίδιο προσαρμοσμένο στο κοινό-στόχο ή στο μεγαλύτερο κοινό.
    • Εξετάστε την ηλικία, την υγεία (έχουν ασθένειες, μαθησιακές δυσκολίες ή αναπηρίες;) Και το επίπεδο εκπαίδευσης του κοινού για να καθορίσετε την καλύτερη προσέγγιση για τη σύνταξη του εγχειριδίου χρήστη.
  2. Συντονίστε τη σχεδίαση του εγχειριδίου χρήστη. Εάν ήσασταν μέλος της ομάδας που βοήθησε στο σχεδιασμό και την ανάπτυξη της συσκευής ή του προϊόντος, μπορεί να είναι δύσκολο να ρίξετε μια αντικειμενική ματιά στο προϊόν για να εξηγήσετε πώς λειτουργεί. Επομένως, πρέπει να ζητήσετε τη συμβουλή ενός συγγραφέα (κατά προτίμηση κάποιον με εμπειρία γραφής) και ενός γραφίστη για να σας βοηθήσει να προετοιμάσετε το εγχειρίδιο χρήσης. Μπορείτε να επιλέξετε αυτά τα άτομα μέσω εξωτερικής συμβουλευτικής εταιρείας ή από τη δική σας εταιρεία ή οργανισμό.
  3. Κάντε μια ανάλυση εργασιών. Η ανάλυση εργασίας είναι η διαδικασία εντοπισμού και οργάνωσης των βημάτων που απαιτούνται για τη χρήση της συσκευής. Μια εμπεριστατωμένη ανάλυση εργασίας προσδιορίζει τα υλικά και τον εξοπλισμό (όπως μπαταρίες, φάρμακα ή άλλα προϊόντα που παρέχονται από τον χρήστη) που απαιτούνται για κάθε βήμα, καθώς και τις ενέργειες, τα σφάλματα και τις συμβουλές αντιμετώπισης προβλημάτων που μπορεί να απαιτούν κάθε βήμα.
    • Εάν έχετε ένα προϊόν που μπορεί να εκτελέσει πολλές διαφορετικές εργασίες ή δευτερεύουσες εργασίες, πρέπει να εκτελέσετε μια ανάλυση εργασιών για κάθε εργασία. Για παράδειγμα: σε ένα αυτοκίνητο μπορείτε να κουνηθείτε, να δέσετε τον εαυτό σας και να ανάψετε ή να σβήσετε τους προβολείς σας. Κάντε μια ανάλυση εργασίας για καθένα από αυτά, εάν είναι απαραίτητο.
  4. Βεβαιωθείτε ότι το προϊόν σας πληροί τις απαιτήσεις για την επισήμανση και την άδεια κυκλοφορίας. Αυτές οι απαιτήσεις διασφαλίζουν ότι τα προϊόντα κατασκευάζονται έχοντας κατά νου την ασφάλεια του χρήστη και ότι η έκθεση του χρήστη σε επικίνδυνες συνθήκες, όπως ακτινοβολία και ηλεκτροπληξία, είναι περιορισμένη. Οι διαφημίσεις πρέπει να αναφέρουν σαφώς τον σκοπό και τις βασικές οδηγίες λειτουργίας ενός προϊόντος και θα πρέπει να χρησιμοποιείτε αυτούς τους πόρους κατά τη σύνταξη του εγχειριδίου του κατόχου σας.
    • Για να είναι αποτελεσματικό το εγχειρίδιο χρήστη ενός προϊόντος, πρέπει να είναι γραμμένο σύμφωνα με τις ετικέτες που είναι τοποθετημένες απευθείας στο προϊόν.
    • Βεβαιωθείτε ότι η συσκευή σας διαθέτει επίσημη άδεια για πώληση πριν γράψετε το εγχειρίδιο χρήσης.
  5. Αποφασίστε για τη διάταξη του εγχειριδίου σας. Υπάρχουν πολλοί σημαντικοί τρόποι με τους οποίους μπορείτε να βελτιώσετε το εγχειρίδιό σας. Πρέπει να βάλετε μια έντονη επικεφαλίδα στην αρχή κάθε ενότητας με κάθε λέξη με κεφαλαία γράμματα. Για παράδειγμα, "Ρύθμιση της συσκευής σας", "Λειτουργία της συσκευής σας" και "Αντιμετώπιση προβλημάτων" μπορεί να είναι έντονες επικεφαλίδες ενότητας.
    • Ένας άλλος τρόπος βελτιστοποίησης του οδηγού σας είναι να χρησιμοποιήσετε δύο στήλες, μία στα δεξιά με κείμενο και η άλλη ακριβώς στα αριστερά του κειμένου, με κουκκίδες, αριθμούς ή μικρά εικονίδια, όπως προειδοποιητικά σημάδια ή κόκκινα θαυμαστικά.
    • Το εγχειρίδιο μπορεί να αποτελείται κυρίως από εικόνες με κάποιο κείμενο κάτω από κάθε εικόνα για να εξηγήσει τη συσκευή ή μπορεί να είναι κυρίως κείμενο με λίγες συνοδευτικές εικόνες. Μπορείτε επίσης να χρησιμοποιήσετε ένα διάγραμμα ροής για να καθοδηγήσετε τον χρήστη. Σκεφτείτε το προϊόν σας και πώς κάθε μέθοδος μπορεί να σας βοηθήσει να γράψετε το εγχειρίδιό σας. Ωστόσο, αποφύγετε την ανάμειξη διαφορετικών διατάξεων σε ένα εγχειρίδιο. Διαλέξτε ένα και κολλήστε με αυτό.

Μέρος 2 από 4: Ενσωμάτωση βασικών πληροφοριών

  1. Οργανώστε λογικά το εγχειρίδιο. Το εγχειρίδιο πρέπει να είναι δομημένο με τέτοιο τρόπο ώστε ο χρήστης να αποκομίσει το μεγαλύτερο όφελος από αυτό. Χωρίστε το εγχειρίδιο σε κεφάλαια ή ενότητες που έχουν νόημα για τη χρήση του προϊόντος και συμπεριλάβετε έναν πίνακα περιεχομένων στο μπροστινό μέρος του εγχειριδίου, έτσι ώστε κάθε ενότητα να μπορεί να βρεθεί γρήγορα.
    • Ένας πίνακας περιεχομένων είναι ιδιαίτερα απαραίτητος για μεγαλύτερα εγχειρίδια.
    • Απαιτείται ένα γλωσσάριο ή ευρετήριο εάν υπάρχουν πολλοί όροι για να εξηγήσετε ότι το κοινό σας μπορεί να μην είναι εξοικειωμένο. Ωστόσο, δεν συνιστάται γλωσσάριο. η καλύτερη επιλογή είναι να εξηγήσετε σύγχυση όρους στο κείμενο του ίδιου του εγχειριδίου. Εάν επιλέξετε να συμπεριλάβετε ένα γλωσσάρι, τοποθετήστε το στο μπροστινό μέρος του εγχειριδίου, αμέσως μετά τον πίνακα περιεχομένων.
    • Μια λίστα πινάκων ή αριθμών είναι απαραίτητη μόνο εάν υπάρχουν περισσότεροι από μερικοί πίνακες ή αριθμοί στο εγχειρίδιο.
    • Απαιτείται ένα παράρτημα για πράγματα που πρέπει να εξηγηθούν αλλά δεν μπορούν να εξηγηθούν αλλού στο εγχειρίδιο, καθώς θα διαταράσσει τη ροή και την εστίαση.
  2. Συμπεριλάβετε τις απαραίτητες προειδοποιήσεις. Οι γενικές προειδοποιήσεις ή προληπτικές πληροφορίες πρέπει να παρέχουν πληροφορίες σχετικά με πιθανούς κινδύνους που οφείλονται σε ακατάλληλη χρήση του προϊόντος, συμπεριλαμβανομένου θανάτου ή σοβαρού τραυματισμού. Αυτές οι προειδοποιήσεις πρέπει να τοποθετούνται στο μπροστινό μέρος του εγχειριδίου, μετά την πρώτη σελίδα, έτσι ώστε ο χρήστης να τις βλέπει πρώτα. Ειδικές προειδοποιήσεις θα πρέπει επίσης να περιλαμβάνονται στο κείμενο του εγχειριδίου αμέσως μετά ή λίγο πριν προταθεί ένα πιθανώς επικίνδυνο βήμα.
    • Για παράδειγμα, μια γενική προειδοποίηση για μια ηλεκτρική συσκευή δεν θα μπορούσε να είναι η χρήση της όταν βρέχει.
    • Μια συγκεκριμένη οδηγία θα μπορούσε να είναι να βεβαιωθείτε ότι τόσο τα χέρια σας όσο και η συσκευή είναι στεγνά πριν συνδέσετε τη συσκευή στην πρίζα.
    • Παρέχετε εικόνες (όπως κρανίο και εγκάρσια οστά) ή κείμενο διαφορετικού χρώματος (όπως κόκκινο κείμενο) για να διακρίνετε την προειδοποίηση από τις υπόλοιπες οδηγίες στο IFU και να τραβήξετε την προσοχή των χρηστών σε αυτό.
  3. Περιγράψτε τη συσκευή. Η περιγραφή σας πρέπει να περιλαμβάνει τόσο γραπτή εξήγηση του σκοπού της συσκευής όσο και μια μικρή γραφική αναπαράσταση της εμφάνισης της συσκευής. Η εικόνα πρέπει να φέρει ετικέτα και να ονομάσει όλους τους διακόπτες, τα κουμπιά και τα προσαρτημένα μέρη που περιέχονται στη συσκευή.
  4. Δώστε οδηγίες εγκατάστασης. Η ενότητα εγκατάστασης πρέπει να περιέχει βασικές πληροφορίες σχετικά με τον τρόπο προετοιμασίας για τη χρήση του προϊόντος ή της συσκευής. Εάν η συσκευή δεν μπορεί να κατασκευαστεί ή να ρυθμιστεί από οικιακό χρήστη, δηλώστε το με σαφήνεια με έντονη επικεφαλίδα στην κορυφή της ενότητας εγκατάστασης. Θα πρέπει επίσης να συμπεριλάβετε τα ακόλουθα:
    • Λίστα ανταλλακτικών
    • Οδηγίες αποσυσκευασίας
    • Προειδοποιήσεις εγκατάστασης
    • Συνέπειες εσφαλμένης εγκατάστασης
    • Ποιος να καλέσει σε περίπτωση δυσκολιών κατά την εγκατάσταση
  5. Δώστε πληροφορίες σχετικά με τη λειτουργία. Αυτή η ενότητα είναι το πιο σημαντικό μέρος του εγχειριδίου χρήστη και πρέπει να παρέχει συγκεκριμένες, λεπτομερείς πληροφορίες σχετικά με τον τρόπο χρήσης της συσκευής. Ξεκινήστε με τη βασική προετοιμασία για τη χρήση της μονάδας, όπως το βύσμα στο καλώδιο τροφοδοσίας ή το πλύσιμο των χεριών σας. Συνεχίστε με λογικά, αριθμημένα βήματα που περιγράφουν τον τρόπο χρήσης της συσκευής, καθώς και τυχόν σχόλια (για παράδειγμα, "Θα ακούσετε ένα κλικ ...") που ο χρήστης μπορεί να περιμένει όταν χρησιμοποιεί σωστά τη συσκευή.
    • Στο τέλος αυτού του κεφαλαίου, οι χρήστες θα πρέπει να παραπέμπονται στο κεφάλαιο αντιμετώπισης προβλημάτων για την επίλυση ζητημάτων που δεν μπορούν να εξηγηθούν γρήγορα.
    • Τοποθετήστε εικόνες όπου είναι απαραίτητο. Ορισμένα βήματα εξηγούνται καλύτερα με εικόνες και λέξεις. Σκεφτείτε τη χρήση φωτογραφιών ή εικονογραφήσεων στο εγχειρίδιό σας.
    • Σε αυτήν την ενότητα, όπως σε οποιαδήποτε ενότητα, θα πρέπει να συμπεριλάβετε σχετικές προειδοποιήσεις ασφαλείας για ακατάλληλη χρήση ή λειτουργία. Για παράδειγμα, θα μπορούσατε να προειδοποιήσετε τους χρήστες αλυσοπρίονου να μην πίνουν αλκοόλ ή να χρησιμοποιούν το αλυσοπρίονο ενώ χρησιμοποιούν συγκεκριμένα φάρμακα.
    • Εάν πιστεύετε ότι θα ωφεληθούν οι χρήστες, σκεφτείτε να συμπεριλάβετε συνδέσμους σε διαδικτυακά βίντεο που αποδεικνύουν την ορθή χρήση και λειτουργία της συσκευής. Μπορείτε να εγγράψετε αυτά τα βίντεο είτε στην αρχή αυτής της ενότητας είτε (στην περίπτωση βίντεο που απεικονίζουν μόνο ένα βήμα) στο τέλος κάθε βήματος.
  6. Συμπεριλάβετε μια περίληψη του προϊόντος στο τέλος. Η περίληψη πρέπει να εμφανίζεται στο τέλος του εγχειριδίου, λίγο πριν από το ευρετήριο, για να παρέχει βασικά βήματα λειτουργίας. Αυτή θα πρέπει να είναι μια απλοποιημένη, απογυμνωμένη έκδοση των επιχειρησιακών πληροφοριών και δεν πρέπει να είναι περισσότερο από μία σελίδα. Συνοψίστε τον τρόπο χρήσης της συσκευής ή του προϊόντος. Συμπεριλάβετε βασικές ειδοποιήσεις, αριθμημένα βήματα που εξηγούν τον τρόπο χρήσης του προϊόντος και αριθμούς τηλεφώνου ή διευθύνσεις ηλεκτρονικού ταχυδρομείου που κατευθύνουν τους χρήστες να βοηθήσουν.
    • Εάν περιμένετε από το χρήστη να αφαιρεί ή να αναφέρεται συχνά στο συνοπτικό φύλλο, μπορείτε να το εκτυπώσετε σε αφαιρούμενη πλαστικοποιημένη κάρτα ή χοντρό χαρτόνι για να διευκολύνετε τη μεταφορά και την αναφορά του χρήστη.
    • Εναλλακτικά, μπορείτε να εφαρμόσετε μια περίληψη απευθείας στο προϊόν για γρήγορη και εύκολη αναφορά από τον χρήστη.

Μέρος 3 από 4: Περιγραφή της συντήρησης του προϊόντος

  1. Εξηγήστε πώς να καθαρίσετε τη συσκευή. Εάν η συσκευή ή το προϊόν σας χρειάζεται καθαρισμό, εξηγήστε πώς να το κάνετε αυτό. Αναφέρετε τα απαιτούμενα καθαριστικά. Πείτε στον αναγνώστη πόσο συχνά καθαρίζετε. Στη συνέχεια, όπως σε οποιοδήποτε άλλο μέρος του εγχειριδίου, συμπεριλάβετε αριθμημένες οδηγίες βήμα προς βήμα σχετικά με τον τρόπο καθαρισμού του.
    • Εάν ο καθαρισμός απαιτεί την αποσυναρμολόγηση του προϊόντος ή την αφαίρεση ενός συγκεκριμένου τμήματος ή εξαρτημάτων, υποδείξτε πώς πρέπει να αποσυναρμολογηθεί το προϊόν.
    • Δώστε μια προειδοποίηση σχετικά με τα αποτελέσματα της αποτυχίας καθαρισμού της συσκευής. Για παράδειγμα, θα μπορούσατε να πείτε, "Εάν η συσκευή δεν καθαριστεί, η απόδοση θα είναι μικρότερη από τη βέλτιστη."
  2. Μετρήστε τον χρήστη πώς να εκτελέσει βασική συντήρηση. Εάν το προϊόν ή η συσκευή επισκευάζεται από τον χρήστη για τη διόρθωση προβλημάτων απόδοσης, δώστε αριθμημένες οδηγίες για το πώς να το κάνετε αυτό για τον χρήστη. Για παράδειγμα, εάν οι μπαταρίες πρέπει να αντικαθίστανται μετά από κάθε 300 ώρες χρήσης, δώστε οδηγίες για το πώς να ελέγξετε αν πρέπει να αντικατασταθούν οι μπαταρίες, πώς να αφαιρέσετε τις νεκρές μπαταρίες και πώς να εγκαταστήσετε τις νέες.
    • Εάν υπάρχουν συγκεκριμένες εργασίες συντήρησης που μπορούν να εκτελεστούν μόνο από πιστοποιημένο τεχνικό, διαιρέστε το τμήμα συντήρησης του εγχειριδίου σε δύο μέρη.
  3. Συζητήστε τις επιλογές αποθήκευσης. Εάν είναι απαραίτητο, το εγχειρίδιο πρέπει να εξηγεί πώς να αποθηκεύσετε σωστά το προϊόν ή τη συσκευή. Θα πρέπει επίσης να συμπεριλάβετε πληροφορίες σχετικά με το γιατί ο χώρος αποθήκευσης είναι απαραίτητος και τις συνέπειες της ακατάλληλης αποθήκευσης. Για παράδειγμα: θα μπορούσατε να γράψετε:
    • Αποθηκεύστε το προϊόν σε δροσερό, ξηρό μέρος. Η ακατάλληλη αποθήκευση μπορεί να μειώσει τη διάρκεια ζωής του προϊόντος σας λόγω συσσώρευσης υγρασίας. "
    • "Μην εκθέτετε το προϊόν σε θερμότητα ή μην το αποθηκεύετε σε θερμοκρασίες πάνω από 50 βαθμούς Κελσίου.Εάν το κάνετε, μπορεί να οδηγήσει σε καύση. "
  4. Παρέχετε πληροφορίες αντιμετώπισης προβλημάτων. Θα μπορούσατε να οργανώσετε αυτήν την ενότητα ως μια λίστα κοινών προβλημάτων και των λύσεών τους. Ομαδοποιήστε παρόμοια προβλήματα κάτω από μια λογική επικεφαλίδα. Με αυτόν τον τρόπο, οι χρήστες μπορούν να βρουν γρήγορα συγκεκριμένα προβλήματα.
    • Για παράδειγμα, εάν υπάρχουν πολλά προβλήματα με τον υπολογιστή να εμφανίζει μια μπλε οθόνη, ομαδοποιήστε τα σε μια διάκριση, όπως "Κοινά προβλήματα οθόνης".
    • Πρέπει επίσης να συμπεριλάβετε έναν αριθμό τηλεφώνου ή / και email για εξυπηρέτηση πελατών σε αυτήν την ενότητα.

Μέρος 4 από 4: Γράψτε ένα ευανάγνωστο εγχειρίδιο

  1. Διαβάστε άλλους οδηγούς χρήσης. Πριν γράψετε ένα εγχειρίδιο για το δικό σας προϊόν, δείτε άλλους αποτελεσματικούς οδηγούς χρήσης. Δώστε προσοχή στη δομή, την επιλογή λέξεων και τη δομή των προτάσεων. Μεγάλες μάρκες όπως η Apple, η Google και η Microsoft παράγουν ισχυρούς, αποτελεσματικούς οδηγούς χρήσης που μπορούν να σας βοηθήσουν να δημιουργήσετε έναν πιο προσεκτικά γραμμένο οδηγό χρήσης.
    • Μην διαβάζετε μόνο όλα εγχειρίδια χρήσης. Διαβάστε τα εγχειρίδια για παρόμοια προϊόντα που πουλάτε. Για παράδειγμα, εάν πουλάτε παιδικά προϊόντα, διαβάστε εγχειρίδια για μωρά και όχι τεχνικά.
  2. Επιλέξτε τα πρότυπα σας. Η τυποποίηση της ορθογραφίας, της επιλογής λέξεων και της διατύπωσης θα κάνει το εγχειρίδιο χρήστη πιο φιλικό προς τον χρήστη. Το εγχειρίδιο στυλ του Σικάγου και το εγχειρίδιο στυλ της Microsoft μπορούν επίσης να είναι χρήσιμοι οδηγοί στυλ κατά τη σύνταξη του εγχειριδίου του κατόχου σας. ελέγξτε και τα δύο για να δείτε αν κάποιος είναι σωστός για το εγχειρίδιό σας.
    • Για παράδειγμα, αντί να χρησιμοποιήσετε και τους δύο "διακόπτες τροφοδοσίας" και "κουμπί λειτουργίας" στο εγχειρίδιό σας, επιλέξτε έναν από τους δύο όρους και ακολουθήστε τον.
  3. Χρησιμοποιήστε την ενεργή φωνή. Η ενεργή φωνή είναι ένας τρόπος γραφής που εξηγεί τα πράγματα από την οπτική γωνία του χρήστη. Είναι πιο κατανοητό από την εναλλακτική, την παθητική φωνή, στην οποία το θέμα είναι απροσδιόριστο.
    • Δοκιμάστε την εφαρμογή Hemingway (www.hemmingwayapp.com) για να εντοπίσετε παθητικά αποσπάσματα στα γραπτά σας.
    • Μελετήστε αυτές τις δύο δειγματοληπτικές προτάσεις - η πρώτη είναι ενεργή και η δεύτερη είναι παθητική:
      • Πρέπει να ανοίξετε το πακέτο αργά και προσεκτικά.
      • Η συσκευασία πρέπει να ανοίγει αργά και προσεκτικά.
  4. Γράψτε αριθμημένες οδηγίες. Οι αριθμητικά παραγγελθείσες οδηγίες βοηθούν τον αναγνώστη να επικεντρωθεί καλύτερα στη διαδικασία χρήσης, σύνδεσης ή κατασκευής του εν λόγω προϊόντος. Αντί να γράφετε μια μακρά, λεπτομερή παράγραφο ή μια σειρά από αρίθμητες παραγράφους, γράψτε τον οδηγό χρήσης σας με απλά, ρητά βήματα, καθένα με σαφή αρίθμηση.
  5. Ξεκινήστε κάθε βήμα με επιτακτική ανάγκη. Ένα επιτακτικό είναι ένα ρήμα προσανατολισμένο στη δράση. Ξεκινώντας κάθε βήμα με ένα ρήμα, δίνετε στον αναγνώστη μια υπόδειξη για την ενέργεια που απαιτείται για την ολοκλήρωση του βήματος. Για παράδειγμα, ανάλογα με το προϊόν για το οποίο γράφετε, μπορείτε να ξεκινήσετε τα βήματά σας με μια εντολή όπως "Σύνδεση", "Επιβεβαίωση" ή "Διαφάνεια". Ωστόσο, μην ξεκινήσετε τα βήματά σας με μια απάντηση από το σύστημα.
    • Για παράδειγμα, εάν η οθόνη γίνει μπλε και αρχίσει να αναβοσβήνει, μην ξεκινήσετε το βήμα με: "Η οθόνη θα αναβοσβήνει και θα γίνει μπλε." Δοκιμάστε: "Πατήστε παρατεταμένα το αρχικό πλήκτρο. Η οθόνη θα αναβοσβήνει και θα γίνει μπλε. "
  6. Προσδιορίστε ποιο λεξιλόγιο θα χρησιμοποιήσετε. Εάν γράφετε ένα εγχειρίδιο yo-yo, το κοινό σας θα είναι κυρίως μικρά παιδιά. Χρησιμοποιήστε απλές λέξεις και λεξιλόγιο για να εξηγήσετε πώς λειτουργεί το yo-yo. Όταν γράφετε ένα εγχειρίδιο ηλεκτρονικού μικροσκοπίου σάρωσης, το ακροατήριό σας αποτελείται από επιστήμονες υψηλής εξειδίκευσης που μπορούν να κατανοήσουν πολύ λεπτομερείς πληροφορίες, οπότε μην αποφεύγετε τη χρήση εξειδικευμένου λεξιλογίου ή εξειδικευμένων εξηγήσεων.
    • Γενικά, προσπαθείτε να αποφύγετε την ορολογία και την τεχνική γλώσσα.
    • Για να είναι αποτελεσματική για την ευρύτερη δυνατή βάση χρηστών, προσπαθήστε να γράψετε σε επίπεδο από την έκτη έως την έβδομη τάξη του δημοτικού.
  7. Κατά την αποστολή ενός προϊόντος στο εξωτερικό, βεβαιωθείτε ότι οι μεταφράσεις σας είναι ακριβείς. Νοικιάστε έναν μεταφραστή για να μεταφράσετε το εγχειρίδιο χρήστη στη μητρική γλώσσα της χώρας στην οποία στέλνετε το προϊόν σας. Μπορείτε επίσης να χρησιμοποιήσετε ένα διαδικτυακό πρόγραμμα μετάφρασης, αλλά ζητήστε από έναν εγγενή ομιλητή να διαβάσει τη μετάφραση και να ελέγξει για σφάλματα.
    • Εάν πολλές ομάδες γλωσσών εκπροσωπούνται στο κοινό σας, συμπεριλάβετε μεταφράσεις του εγχειριδίου χρήστη σε κάθε σχετική γλώσσα.
    • Ο μεταφραστής πρέπει να είναι εξοικειωμένος με το προϊόν, καθώς μπορεί να υπάρχουν διαφορετικές λέξεις στη γλώσσα προορισμού για συγκεκριμένους όρους που δεν είναι μεταφράσεις λέξη-προς-λέξη.
  8. Γράψτε σε σύντομες προτάσεις. Αντί για μερικές μεγάλες παραγράφους, χρησιμοποιείτε πολλές σύντομες παραγράφους. Αναζητήστε λογικά διαλείμματα σε κάθε ενότητα και αφομοιώστε χρήσιμες πληροφορίες σε κομμάτια μιας ή δύο προτάσεων. Το ίδιο ισχύει και στο επίπεδο των προτάσεων. Διατηρήστε τις προτάσεις σας σύντομες και απλές, παρά μεγάλες και λεκτικές.
    • Εάν ένα βήμα είναι πολύ μεγάλο, χωρίστε το σε μικρότερα βήματα. Αυτό δεν θα μειώσει τον αριθμό λέξεων, αλλά οι αλλαγές γραμμής θα διευκολύνουν την ανάγνωση.
  9. Ελέγξτε το εγχειρίδιο για σφάλματα. Ένα εγχειρίδιο μπορεί να χάσει την αξιοπιστία λόγω λαθών γραμματικής και ορθογραφίας. Ζητήστε από έναν συνάδελφο ή τεχνικό συγγραφέα να επεξεργαστεί και να διορθώσει το εγχειρίδιο. Εκτός από την ορθογραφία και τη γραμματική, ο διορθωτής πρέπει να δώσει προσοχή στα ακόλουθα:
    • Παθητική φωνή
    • Ασαφής ή συγκεχυμένη γλώσσα
    • Αναδιπλούμενη δομή πρότασης
    • Υπερβολικά μεγάλες παραγράφους

Συμβουλές

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