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