Οδηγίες συγγραφής: Ορισμός και παραδείγματα

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

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

Οι οδηγίες γράφονται συχνά με τη μορφή αριθμημένων λίστα έτσι ώστε οι χρήστες να μπορούν να αναγνωρίζουν σαφώς την ακολουθία των εργασιών

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

"Οι καλές οδηγίες είναι σαφείς, κατανοητές, πλήρεις, συνεπείς και αποτελεσματικές." (Τζον Μ. Penrose, et αϊ.,

Η ελαφρύτερη πλευρά των οδηγιών: Εγχειρίδιο για τους πρόσφατα νεκρούς

Ήρα: Εντάξει, μελετήσατε το εγχειρίδιο;
Αδάμ: Λοιπόν, δοκιμάσαμε.
Ήρα: Το ενδιάμεσο κεφάλαιο διεπαφής για το στοιχειωμένο τα λέει όλα. Βγάλτε τα μόνοι σας. Είναι το σπίτι σου. Τα στοιχειωμένα σπίτια δεν είναι εύκολα προσβάσιμα.
Βαρβάρα: Λοιπόν, δεν το καταλαβαίνουμε.
Ήρα: Ακουσα. Στρέψτε τα πρόσωπά σας αμέσως. Προφανώς δεν κάνει καλό να τραβάς τα κεφάλια σου μπροστά σε ανθρώπους αν δεν μπορούν να σε δουν.
Αδάμ: Πρέπει να ξεκινήσουμε πιο απλά τότε;
Ήρα: Ξεκινήστε απλά, κάντε ό, τι γνωρίζετε, χρησιμοποιήστε τα ταλέντα σας, εξασκηθείτε. Θα έπρεπε να μελετούσες αυτά τα μαθήματα από την πρώτη μέρα. (Sylvia Sidney, Alec Baldwin και Geena Davis στο Σκαθαροζούμης, 1988)

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

• Συγκεκριμένο και ακριβές τίτλος
• Εισαγωγή με βασικές πληροφορίες
• Απαραίτητη λίστα μερών, εργαλείων και προϋποθέσεων
• Διαδοχικά βήματα
• Γραφικά
• Πληροφορίες ασφάλειας
• συμπέρασμα που σηματοδοτεί την ολοκλήρωση της εργασίας

Τα διαδοχικά διατεταγμένα βήματα είναι το επίκεντρο ενός συνόλου οδηγιών και συνήθως καταλαμβάνουν μεγάλο μέρος του χώρου στο έγγραφο. "
(Richard Johnson-Sheehan, Τεχνική επικοινωνία σήμερα. Pearson, 2005)

1. Χρησιμοποιήστε σύντομες προτάσεις και σύντομες παραγράφους.
2. Τακτοποιήστε τα σημεία σας με λογική σειρά.
3. Κάντε τις δηλώσεις σας ειδικός.
4. Χρησιμοποιήστε το επιτακτική διάθεση.
5. Βάλτε το πιο σημαντικό στοιχείο σε κάθε πρόταση στην αρχή.
6. Πείτε ένα πράγμα σε κάθε πρόταση.
7. Επιλέξτε προσεκτικά τις λέξεις σας, αποφεύγοντας ακατάληπτη γλώσσα και τεχνικούς όρους εάν μπορείτε.
8. Δώστε ένα παράδειγμα ή ένα αναλογία, αν νομίζετε ότι μια δήλωση μπορεί να προκαλέσει παζλ στον αναγνώστη.
9. Ελέγξτε το ολοκληρωμένο πρόχειρο για λογική παρουσίασης.
10. Μην παραλείψετε βήματα και μην κάνετε συντομεύσεις.

(Προσαρμοσμένο από Γράφοντας με ακρίβεια από τον Jefferson D. Μπέιτς. Πιγκουίνος, 2000)

Οι οδηγίες μπορούν να είναι είτε ανεξάρτητα έγγραφα είτε μέρος άλλου εγγράφου. Σε κάθε περίπτωση, το πιο συνηθισμένο σφάλμα είναι να τα κάνετε πολύ περίπλοκα για το κοινό. Εξετάστε προσεκτικά το τεχνικό επίπεδο των αναγνωστών σας. Χρήση λευκό διάστημα, γραφικά και άλλα στοιχεία σχεδίασης για να κάνουν τις οδηγίες ελκυστικές. Το πιο σημαντικό, φροντίστε να συμπεριλάβετε αναφορές Προσοχή, Προειδοποίηση και Κίνδυνος πριν τα βήματα στα οποία εφαρμόζονται. "
(William Sanborn Pfeiffer, Οδηγός τσέπης για τεχνική επικοινωνία, 4η έκδοση. Pearson, 2007)

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