Η τεχνική γραφή απαιτεί γενικά δύο τύπους γνώσεων: το δημογραφικό από το οποίο θα διαβαστεί η γραφή σας και κάποια κατανόηση του τεχνικού θέματος.
Η τεχνική γραφή απαιτεί γενικά δύο τύπους γνώσεων: το δημογραφικό από το οποίο θα διαβαστεί η γραφή σας και κάποια κατανόηση του τεχνικού θέματος που υπάρχει.
Κατανοήστε το κοινό σας. Μπορεί να σας δοθεί μια αναφορά για το ποιος θα είναι το κοινό για το γράψιμο ή μπορεί να χρειαστεί να το καταλάβετε μόνοι σας. Είτε έτσι είτε αλλιώς, θα πρέπει να γνωρίζουν τις βασικές δημογραφικές των αναγνωστών, συμπεριλαμβανομένου του τρόπου με πολλές τεχνικές γνώσεις που έχουν για το θέμα στο χέρι. Ένα κοινό νέων χρηστών για ένα κομμάτι λογισμικού θα πρέπει να γραφτεί σε πολύ διαφορετικό τρόπο από μια ομάδα προηγμένων προγραμματιστών. Η χρήση τεχνικής ορολογίας θα πρέπει να προσαρμοστεί ανάλογα. Βάλτε τον εαυτό σας στη θέση του αναγνώστη και γράψτε όσο το δυνατόν σαφέστερα.
Γνωρίστε το θέμα σας. Εάν είστε τακτικός τεχνικός συγγραφέας, μπορεί να μην είναι δυνατό να γνωρίζετε τα πάντα για κάθε θέμα για το οποίο γράφετε. Αλλά θα πρέπει να γνωρίζετε αρκετά για αυτό για να είστε σίγουροι ότι μπορείτε να επικοινωνείτε με ακρίβεια.
Χρησιμοποιήστε την παρούσα ένταση. Εκτός αν σας έχουν δοθεί συγκεκριμένες οδηγίες για τη χρήση διαφορετικής έντασης, η τεχνική γραφή πρέπει πάντα να γίνεται στην παρούσα ένταση.
Να είστε αντικειμενικοί. Η τεχνική γραφή πρέπει να γίνεται με αντικειμενικό τρόπο, χωρίς να εξάγονται συμπεράσματα και να μην χρησιμοποιούνται προσωπικές αντωνυμίες.
Γράψτε έναν πίνακα περιεχομένων. Ένας πίνακας περιεχομένων είναι απαραίτητος για σχεδόν οποιαδήποτε μορφή τεχνικής γραφής και θα βοηθήσει τους αναγνώστες να βρουν τις πληροφορίες που χρειάζονται περισσότερο.
Περάστε λίστες βημάτων. Τα βήματα που πρέπει να ληφθούν για την ολοκλήρωση της εργασίας, τη χρήση του εξοπλισμού, τη λειτουργία του λογισμικού κ.λπ., πρέπει να γράφονται ένα προς ένα. Φροντίστε να καλύψετε τυχόν ερωτήσεις που θα μπορούσαν να προκύψουν για κάθε βήμα. Τα βήματα πρέπει να αριθμούνται κατά σειρά και να είναι προσβάσιμα μέσω του πίνακα περιεχομένων για γρήγορη αναφορά.
Η τεχνική γραφή πρέπει να γίνεται με αντικειμενικό τρόπο, χωρίς να εξάγονται συμπεράσματα και να μην χρησιμοποιούνται προσωπικές αντωνυμίες.
Χρησιμοποιήστε εργαλεία και πίνακες. Η μακροχρόνια τεχνική γραφή συχνά έχει γνώση που βασίζεται σε αυτό - οι κύριες πληροφορίες πρέπει να γίνουν κατανοητές πριν να είναι οι υπόλοιπες. Μερικές φορές μπορεί να σας βοηθήσει να συμπεριλάβετε ετικέτες με εικόνες, γραφήματα και πίνακες πληροφοριών για να διαβάσετε πολύπλοκες ιδέες που είναι δύσκολο να περιγραφούν με λέξεις ή που θα πρέπει να αναφερθούν αργότερα στο έγγραφο.
Χρησιμοποιήστε ειδικές ειδοποιήσεις. Εκτός από τις οδηγίες, θα υπάρχουν περιπτώσεις όπου η χρήση ειδικών ειδοποιήσεων στο κείμενο θα είναι χρήσιμη για τον αναγνώστη. Οι ειδοποιήσεις θα είναι προειδοποιήσεις, προειδοποιήσεις για πιθανές επικίνδυνες καταστάσεις, κ.λπ. Οι ειδικές ειδοποιήσεις μπορεί να περιλαμβάνουν προστατευτικές ιδέες, όπως σύσταση για τη χρήση προστατευτικών γυαλιών ή αεριζόμενου χώρου εργασίας. Μπορεί επίσης να υπάρχουν ειδοποιήσεις σχετικά με το τι πρέπει να κάνετε σε περίπτωση που ένα βήμα έχει γίνει εσφαλμένα, πώς να διορθώσετε λάθη κ.λπ.
Δοκιμάστε το έγγραφο. Συχνά είναι καλή ιδέα να δοκιμάσετε το έγγραφο σε κάποιον που βρίσκεται κοντά στο δημογραφικό στόχο που μπορεί να σας πει εάν λείπουν πληροφορίες. Εάν το έγγραφο προορίζεται για αρχικούς χρήστες των πληροφοριών, θα πρέπει να είναι εύκολο να βρείτε κάποιον σε παρόμοια θέση. Εάν είναι σε θέση να διαβάσει το έγγραφο χωρίς περαιτέρω ερωτήσεις σχετικά με τον τρόπο χρήσης των πληροφοριών, τότε το έγγραφο είναι πλήρες.
