Η τεχνική γραφή μεταδίδει τεχνικές πληροφορίες σχετικά με μια δεξιότητα ή ένα προϊόν στους αναγνώστες. Χρησιμοποιείται συνήθως σε τεχνικούς και επαγγελματικούς τομείς. Ως τεχνικός συγγραφέας, συχνά γράφετε έγγραφα όπως οδηγούς χρήσης, τεκμηρίωση διεπαφής προγραμματισμού εφαρμογών (API) και εγχειρίδια επισκευής και προϊόντος.
Όπως και άλλες θέσεις γραφής, η τεχνική γραφή έχει ειδικές οδηγίες. Η τήρηση αυτών των οδηγιών θα σας βοηθήσει να γράψετε καλά δομημένα έγγραφα και να βελτιστοποιήσετε τον τρόπο με τον οποίο οι αναγνώστες κατανοούν τη δουλειά σας. Ακολουθούν ορισμένοι κανόνες που πρέπει να ακολουθήσετε για να γίνετε καλός τεχνικός συγγραφέας.
1. Καθορίστε το κοινό σας
Η ανάλυση κοινού είναι ένας απαραίτητος παράγοντας σε ένα καλό τεχνικό έγγραφο. Η γνώση του κοινού σας σάς βοηθά να προσδιορίσετε το είδος των πληροφοριών για τις οποίες θα γράψετε, τον τρόπο με τον οποίο θα πρέπει να το δομήσετε και τις τεχνικές λεπτομέρειες της γλώσσας σας. Υπάρχουν τέσσερα κύρια είδη κοινού για την τεχνική γραφή: στελέχη, ειδικοί, τεχνικοί και μη ειδικοί.
Τα στελέχη είναι άτομα που χρηματοδοτούν το προϊόν και λαμβάνουν τις πολιτικές, διοικητικές και οικονομικές αποφάσεις που το διέπουν. Οι τεχνικοί είναι οι άνθρωποι που κατασκευάζουν, χειρίζονται και επισκευάζουν αυτά τα προϊόντα. Οι ειδικοί σχεδιάζουν, δοκιμάζουν και γνωρίζουν τα πάντα για το προϊόν, ενώ οι μη ειδικοί είναι οι τελικοί χρήστες των προϊόντων. Πρέπει να λάβετε υπόψη το κοινό σας για να καθορίσετε τον καλύτερο τόνο και στυλ γραφής που θα χρησιμοποιήσετε.
2. Προσδιορίστε τις ανάγκες του κοινού σας
Εκτός από τη γνώση και τον καθορισμό του κοινού σας, είναι σημαντικό να κατανοήσετε τους στόχους, τα ενδιαφέροντα και τις ανάγκες του. Η ολοκλήρωση της ανάλυσης κοινού είναι το κλειδί για την προετοιμασία εγγράφων, καθώς είναι λιγότερο πιθανό να γράψετε χωρίς λόξυγγα και να γνωρίζετε καλά τις ανάγκες του κοινού σας.
Για να πραγματοποιήσετε μια ολοκληρωμένη ανάλυση κοινού, πρέπει να λάβετε υπόψη το ιστορικό του κοινού σας, τις υπάρχουσες γνώσεις το προϊόν, την εμπειρία, τις ανάγκες, τα ενδιαφέροντα, τα δημογραφικά χαρακτηριστικά, τον πολιτισμό και τις προτιμήσεις επικοινωνίας και στόχους. Αυτές οι πληροφορίες θα σας βοηθήσουν να παρουσιάσετε τις ιδέες σας πιο αποτελεσματικά και αποδοτικά.
3. Γνωρίστε το όριο της γνώσης του κοινού σας
Ως τεχνική ανάλυσης κοινού, μπορείτε να χρησιμοποιήσετε έρευνες και ερωτηματολόγια για να γνωρίζετε το όριο των γνώσεων του κοινού σας. Μπορείτε επίσης να προμηθευτείτε δημοφιλείς απόψεις και στερεότυπα, προσωπική εμπειρία, καταιγισμό ιδεών και σχόλια κοινού, από το τμήμα μάρκετινγκ.
Εάν χρησιμοποιήσετε σωστά τα εργαλεία που αναφέρονται παραπάνω, θα ξέρετε πόσο το κοινό-στόχος σας κατανοεί τις πληροφορίες που σκοπεύετε να μεταφέρετε. Αυτές οι πληροφορίες θα καθορίσουν σε μεγάλο βαθμό τη δομή, τα όρια και το εύρος του εγγράφου σας, δίνοντάς σας μια αίσθηση κατεύθυνσης.
4. Κρατήστε τη γλώσσα σας απλή
Η τεχνική γραφή υποτίθεται ότι παρουσιάζει ένα υπερβολικά περίπλοκο θέμα. Αυτό το κάνει χρησιμοποιώντας έναν απλό οδηγό στυλ γραφής. Θα πρέπει να βεβαιωθείτε ότι ο μέσος αναγνώστης μπορεί εύκολα να κατανοήσει τη γραφή σας.
Ωστόσο, πρέπει να σημειώσετε ότι η κατανόηση του κοινού σας είναι επίσης βασικό για το στυλ γλώσσας που επιλέγετε. Για παράδειγμα, επαγγελματική ορολογία σε ένα έγγραφο σχετικά με διεπαφές προγραμματισμού εφαρμογών (API) μπορεί να είναι κατάλληλο για τεχνικούς αλλά όχι για τελικούς χρήστες. Κατά συνέπεια, πρέπει να χρησιμοποιείτε εύκολα κατανοητή γλώσσα για να βοηθήσετε την κατανόηση του κοινού. Μπορεί επίσης να θέλετε να μάθετε πώς να χρησιμοποιήσετε ένα εργαλείο όπως το Microsoft Editor για να ελέγξετε την εργασία σας και να βεβαιωθείτε ότι η γραφή είναι στο σημείο.
5. Χρησιμοποιήστε Περιγράμματα
Τα περιγράμματα δίνουν στους αναγνώστες σας μια ιδέα για το τι να περιμένουν στο έγγραφο. Ένα έγγραφο χωρίς περίγραμμα κατακλύζει τους αναγνώστες, καθώς τους αναγκάζει να διαβάσουν ολόκληρο το κείμενο όταν τους ενδιαφέρει μόνο να αποκτήσουν συγκεκριμένες γνώσεις.
Ως τεχνικός συγγραφέας, η περιγραφή του εγγράφου σας δίνει επίσης μια αίσθηση κατεύθυνσης όταν γράφετε. Σας κρατά σε καλό δρόμο και διασφαλίζει ότι δεν χάνετε ή υποτιμάτε σχετικά σημεία. Επιπλέον, βελτιώνει τη δομή του εγγράφου σας και χρησιμεύει ως ανατροφοδότηση για το τι σκοπεύετε να καλύψετε.
6. Χρησιμοποιήστε γραφικά όπου χρειάζεται
Η προσοχή των περισσότερων αναγνωστών έλκεται φυσικά από τα γραφικά σε σύγκριση με το κείμενο. Στα τεχνικά έγγραφα, τα κατάλληλα γραφικά μπορούν να βελτιώσουν την κατανόηση του κειμένου από τους αναγνώστες παρουσιάζοντας τις πληροφορίες καθαρά και με έμφαση.
Ωστόσο, ως τεχνικός συγγραφέας, θα πρέπει να προσέχετε να μην χρησιμοποιείτε γραφικά για τη διακόσμηση εγγράφων. Οι πίνακες, τα γραφήματα, τα γραφήματα, οι φωτογραφίες και οι εικόνες είναι γραφικά που χρησιμοποιούνται συνήθως και μπορούν να βελτιώσουν τη συνολική δομή του εγγράφου και να ελκύσουν τους αναγνώστες. Τούτου λεχθέντος, αν είστε νέος στα Έγγραφα Google, ορίστε πώς να δημιουργήσετε και να επεξεργαστείτε πίνακες στα Έγγραφα Google.
7. Ενεργοποιήστε τους αναγνώστες σας
Ενώ μπορεί να προσπαθείτε να μεταφέρετε τεχνικές πληροφορίες στους αναγνώστες σας, είναι σημαντικό να τους δεσμεύσετε επίσης. Κάθε τεχνικό έγγραφο είναι αναγνωστοκεντρικό και πρέπει να γράφεται σύμφωνα με το γούστο του αναγνώστη και όχι του συγγραφέα. Για να είναι χρήσιμο το έγγραφό σας πρέπει να ικανοποιηθεί η πνευματική περιέργεια του αναγνώστη σας.
Μπορείτε να προσελκύσετε ενεργά τον αναγνώστη σας γράφοντας για να εκφραστείτε, όχι να εντυπωσιάσετε και να φτάσετε κατευθείαν στο θέμα. Αποφύγετε τις συντομογραφίες και την ορολογία, χρησιμοποιήστε πολύ λευκό χώρο για να βελτιώσετε την οπτική παρουσίαση και χρησιμοποιήστε τίτλους για να καθοδηγήσετε τον αναγνώστη σας.
8. Μην αναφέρετε πληροφορίες ευαίσθητες στον χρόνο
Η αποφυγή παραπομπών σε χρονικά ευαίσθητες πληροφορίες, ειδικά σε συγκρίσιμη περίοδο, είναι πάντα προτιμότερη. Είναι ασφαλέστερο και σοφότερο να χρησιμοποιείτε ανάλυση που έχει αντέξει στη δοκιμασία του χρόνου, γεγονός που την καθιστά αειθαλής και πάντα κατάλληλη για όσους θα διαβάσουν το έγγραφό σας στο μέλλον.
Πρέπει επίσης να σημειώσετε ότι η επισύναψη συγκεκριμένων ετών, όπως το "2019", για να τονιστεί η άποψή σας μπορεί να μειώσει τη χρησιμότητα του εγγράφου σας με την πάροδο του χρόνου, εκτός από συγκεκριμένες περιπτώσεις. Μπορείτε να το αποτρέψετε χρησιμοποιώντας ένα ευρύτερο χρονικό πλαίσιο όπως "Τα τελευταία επτά χρόνια", δίνοντας έτσι στην εργασία σας ένα επίπεδο αξιοπιστίας.
9. Χρησιμοποιήστε σχετικά παραδείγματα
Όταν γράφετε ένα τεχνικό έγγραφο, χρησιμοποιήστε ζωντανές εμφανίσεις για να τονίσετε τα σημεία σας. Εφόσον το κοινό σας διαβάζει τα γραπτά σας για να αποκτήσει μια δεξιότητα, να λύσει ένα πρόβλημα ή να μάθει κάποιες οδηγίες, πρέπει να του παρέχετε πρακτικά και σχετικά παραδείγματα.
Αυτά τα παραδείγματα ενισχύουν την αναγνωσιμότητα της εργασίας σας και μεταδίδουν περίπλοκες πληροφορίες στον αναγνώστη σας, παρέχοντας πλαίσιο για προϊόντα και διαδικασίες. Με αυτόν τον τρόπο, είναι πιο πιθανό να χρησιμοποιήσουν τα προϊόντα σκόπιμα και με ασφάλεια.
10. Λάβετε μια κριτική από τρίτους πριν από τη δημοσίευση
Ένα τεχνικό έγγραφο πρέπει πάντα να διέρχεται από μια διαδικασία συνεργασίας που περιλαμβάνει τον συγγραφέα και τον κριτικό. Η αξιολόγηση τρίτου μέρους βοηθά στη δημιουργία ενός εγγράφου που εστιάζει στο κοινό, χωρίς σφάλματα και έχει αντίκτυπο.
Ως αρχικός συντάκτης του εγγράφου, μπορεί να έχετε γράψει πολλά προσχέδια πριν δημιουργήσετε το τελικό έγγραφο. Ωστόσο, ανεξάρτητα από το πόσο καλό είναι το έγγραφό σας, μην εξαρτάστε μόνο από το μυαλό σας.
Γίνετε Επαγγελματίας Τεχνικός Συγγραφέας σήμερα
Η κατανόηση των βασικών κανόνων που καθοδηγούν την τεχνική γραφή θα σας κάνει πιο ικανούς και περιζήτητους. Πολλοί οργανισμοί γνωρίζουν πόσο σημαντικό είναι για τα προϊόντα ή τις υπηρεσίες τους να διατίθενται καλά στην αγορά στους τελικούς χρήστες και το να τους βοηθήσετε να επιτύχουν αυτό είναι ο στόχος σας ως τεχνικός συγγραφέας.