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

1. Μεγάλοι βομβαστικοί κεφαλίδες

Θα παρατηρήσετε ότι οι κεφαλίδες στο PCMech, όπως αυτό ακριβώς πάνω από αυτή την πρόταση, είναι τεράστιες. Αυτό συμβαίνει επειδή είναι ευκολότερο να τα δείτε, να διαβάσετε και να μάθετε πού βρίσκεστε στο έγγραφο.

2. Λιγότερες λέξεις

Λάθος τρόπο:

Η παρακάτω τεκμηρίωση εξηγεί τον τρόπο χρήσης και λειτουργίας του Fanny Whacker 2000.

Σωστό τρόπο:

Οδηγίες για τη χρήση του Fanny Whacker 2000

Να θυμάστε πάντα αυτή τη φράση κατά την εγγραφή της τεκμηρίωσης: ΠΗΓΑΙΝΕΤΕ ΣΤΟ ΣΗΜΕΙΟ ΠΟΥ ΘΑ ΓΡΑΜΜΗΣΕΙ ΠΟΛΥ ΔΥΝΑΤΟΤΗΤΑ

3. Περάστε άχρηστες αναφορές

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

Για περισσότερες πληροφορίες σχετικά με το Turnip Twaddler του Fanny Whacker 2000, παρακαλούμε δείτε το έγγραφο FU, υποενότητα ID10T.

... μην το κάνετε αυτό.

4. Ημερομηνία. Πάντα.

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

Μπορείτε να γράψετε αυτό ως "Τελευταία αναθεώρηση (εισαγάγετε την ημερομηνία εδώ)".

5. Οι προειδοποιήσεις πρέπει πάντα να δημοσιεύονται πριν από το σημείο μη επιστροφής

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

Παράδειγμα:

Βήμα 5. Καθαρισμός του Fanny Whacker 2000 Τα πτερύγια του FW2000 πρέπει να καθαρίζονται απαλά χρησιμοποιώντας ένα μη λειαντικό μαλακό πανί. ΠΡΟΕΙΔΟΠΟΙΗΣΗ: Χρησιμοποιείτε μόνο διαλύτη χωρίς αμμωνία για να μην εκραγεί το FW2000 και να οδηγήσει σε πρόωρο θάνατο.

Σε τελική σημείωση, η καλή τεκμηρίωση δεν είναι από το να είναι υπερ-περιγραφικό για κάθε πιθανό πράγμα που μπορεί να φανταστεί κανείς. Διαβάστε την τεκμηρίωσή σας και αναρωτηθείτε, διδάσκει σωστά; Εάν η απάντηση είναι ναι, η επόμενη ερώτηση είναι, διδάσκει γρήγορα; Εάν ναι, η τεκμηρίωση είναι καλή.