Διαδραστικοί οδηγοί προϊόντων για ομάδες τεκμηρίωσης
Οι ομάδες τεκμηρίωσης μπορούν να μετατρέψουν την εγκεκριμένη γνώση προϊόντων σε οδηγούς για τις στιγμές που οι χρήστες χρειάζεται να ενεργήσουν. Ένα χρήσιμο πρώτο έργο συνδέει μια επαναλαμβανόμενη ερώτηση με μια αξιόπιστη πηγή, το κατάλληλο προϊόν και μια εργασία που μπορεί να ελεγχθεί στην πράξη.
Εντοπίστε μια εργασία μέσα στη βιβλιοθήκηΔιατηρήστε ορατή την ευθύνη για την πηγήΚάντε ανιχνεύσιμη την επαναχρησιμοποίηση μεταξύ καναλιών
Πρόβλημα
Τι σας βοηθά να προετοιμάσετε αυτή η ροή εργασίας
Οι ομάδες τεκμηρίωσης μπορούν να μετατρέψουν την εγκεκριμένη γνώση προϊόντων σε οδηγούς για τις στιγμές που οι χρήστες χρειάζεται να ενεργήσουν. Ένα χρήσιμο πρώτο έργο συνδέει μια επαναλαμβανόμενη ερώτηση με μια αξιόπιστη πηγή, το κατάλληλο προϊόν και μια εργασία που μπορεί να ελεγχθεί στην πράξη.
Χρησιμοποιήστε το ακόλουθο πλαίσιο ώστε το αίτημα ή η εργασία να μπορεί να ελεγχθεί: επαναλαμβανόμενη ερώτηση, κατάλληλο προϊόν, εγκεκριμένη πηγή, αντιστοίχιση ορολογίας, υπεύθυνος ελέγχου και διαδικασία αλλαγών. Καταγράψτε όσα έχουν επαληθευτεί και όσα παραμένουν άγνωστα, έπειτα χρησιμοποιήστε την κατάλληλη πηγή προϊόντος για να καθορίσετε το επόμενο εγκεκριμένο βήμα.
Πρακτική καθοδήγηση
Εκτελέστε την εργασία με το σωστό πλαίσιο.
Εντοπίστε μια εργασία μέσα στη βιβλιοθήκη
Εξετάστε τις ερωτήσεις υποστήριξης για επαναλαμβανόμενη σύγχυση γύρω από ένα εξάρτημα, χειριστήριο ή βήμα. Εντοπίστε την εγκεκριμένη απάντηση και προσδιορίστε τα προϊόντα στα οποία εφαρμόζεται. Ξεκινήστε με αυτή την οριοθετημένη εργασία αντί να αναδημιουργήσετε κάθε εγχειρίδιο ή να επιλέξετε περιεχόμενο μόνο λόγω πολλών προβολών σελίδας.
Επαναλαμβανόμενη ερώτηση
Κατάλληλο προϊόν
Εγκεκριμένη πηγή
Διατηρήστε ορατή την ευθύνη για την πηγή
Καταγράψτε την αναθεώρηση του εγχειριδίου ή άρθρου, τον αρμόδιο ειδικό και την κατάσταση ελέγχου. Ο οδηγός είναι παράγωγο περιεχόμενο που απαιτεί την ίδια προσοχή στις αλλαγές με την πηγή του. Αποφασίστε πριν από τη δημοσίευση πώς μια ενημέρωση φτάνει στο οπτικό υλικό, στο κείμενο εργασίας και στη γνώση του βοηθού.
Αντιστοίχιση ορολογίας
Υπεύθυνος ελέγχου
Διαδικασία αλλαγών
Ελέγξτε τα προσχέδια που εξήχθησαν σε σχέση με την πηγή
Η τεχνητή νοημοσύνη μπορεί να βοηθήσει στην οργάνωση κειμένου και προτεινόμενων βημάτων, αλλά ο συγγραφέας και ο υπεύθυνος προϊόντος επαληθεύουν την αντιστοίχιση. Κρατήστε ασαφείς αναφορές σε διαγράμματα, ελλείπουσες προϋποθέσεις και ασυνεπή ορολογία σε μια λίστα ελέγχου. Ένα καλογραμμένο προσχέδιο δεν πρέπει να κρύβει κενό στην πηγή που εξακολουθεί να χρειάζεται τεχνική διευκρίνιση.
Παράδειγμα: η υποστήριξη χρησιμοποιεί διαφορετικό όνομα εξαρτήματος
Ενδεικτική συντακτική περίπτωση: οι πελάτες αποκαλούν ένα εξάρτημα σύνδεσης στήριγμα, ενώ το εγχειρίδιο χρησιμοποιεί όρο καταλόγου. Ο οδηγός συνδέει και τους δύο όρους με την εγκεκριμένη ονομασία και τη θέση στο διάγραμμα. Η επίσημη αναφορά εξαρτήματος παραμένει άθικτη, κάνοντας την εξήγηση κατανοητή χωρίς αλλαγή της ταυτότητας των εξαρτημάτων του προϊόντος.
Κάντε ανιχνεύσιμη την επαναχρησιμοποίηση μεταξύ καναλιών
Χρησιμοποιήστε την ίδια εγκεκριμένη εργασία από σελίδα προϊόντος, άρθρο υποστήριξης ή σημείο πρόσβασης QR, όπου ενδείκνυται. Επαληθεύστε ότι κάθε σημείο εισόδου προσδιορίζει μοντέλο και αναθεώρηση. Η επαναχρησιμοποίηση πρέπει να μειώνει αντικρουόμενες εξηγήσεις, όχι να αντιγράφει μια ανεξέλεγκτη απάντηση σε πολλές σελίδες.
Αξιολογήστε τις ερωτήσεις που ο οδηγός αφήνει αναπάντητες
Καταγράψτε αποκλίσεις πηγών, επαναλαμβανόμενες διευκρινίσεις και αναπάντητες ερωτήσεις ανά εργασία προϊόντος. Εξετάστε αυτά τα στοιχεία με τον υπεύθυνο τεκμηρίωσης. Δώστε προτεραιότητα σε σαφέστερο οπτικό υλικό ή σε ελλείπουσα ενότητα πηγής βάσει των ενδείξεων και συγκρίνετε αντίστοιχες εργασίες πριν αποδώσετε στον οδηγό αλλαγές στον όγκο υποστήριξης.
Πεδία για επαναχρησιμοποίηση στο επόμενο αρχείο σας
Ετοιμάστε μια καταγραφή για διαδραστικούς οδηγούς προϊόντων για ομάδες τεκμηρίωσης που συνδέει την πηγή με την πραγματική εργασία. Αντιγράψτε τα παρακάτω πεδία πλαισίου στη δική σας διαδικασία προϊόντος, υποστήριξης ή ελέγχου. Προσθέστε την κατάλληλη αναφορά πηγής και τον υπεύθυνο, ώστε η επόμενη ομάδα να γνωρίζει τι χρειάζεται ακόμη επιβεβαίωση.
Επαναλαμβανόμενη ερώτηση
Κατάλληλο προϊόν
Εγκεκριμένη πηγή
Αντιστοίχιση ορολογίας
Υπεύθυνος ελέγχου
Διαδικασία αλλαγών
Ροή εργασίας
Προετοιμάστε μια πρώτη ελεγμένη ροή εργασίας
01
Προσδιορίστε το πλαίσιο
Καταγράψτε την επαναλαμβανόμενη ερώτηση, το κατάλληλο προϊόν και την εγκεκριμένη πηγή και προσδιορίστε την εφαρμοστέα πηγή.
02
Ελέγξτε μία εργασία
Χρησιμοποιήστε το σενάριο ανιχνεύσιμης επαναχρησιμοποίησης μεταξύ καναλιών για να συζητήσετε το εύρος, έπειτα ελέγξτε την πραγματική εργασία και τα εκκρεμή πεδία με τον υπεύθυνό της.
03
Ελέγξτε την επόμενη παραπομπή
Διατηρήστε την αντιστοίχιση ορολογίας, τον υπεύθυνο ελέγχου, τη διαδικασία αλλαγών και το ανεπίλυτο ερώτημα στην τελική καταγραφή.
Συχνές ερωτήσεις
Ερωτήσεις για αυτή την εργασία.
Ποιος είναι ένας κατάλληλος πρώτος οδηγός για ομάδα τεχνικής συγγραφής;
Επιλέξτε μια επαναλαμβανόμενη ερώτηση προϊόντος με εγκεκριμένη πηγή και σαφές αποτέλεσμα εργασίας. Ένας ασαφής προσανατολισμός ή μια αναφορά εξαρτήματος συχνά ελέγχεται ευκολότερα από τη μεταφορά ολόκληρου εγχειριδίου προϊόντος.
Ποια πεδία πρέπει να περιλαμβάνει το αρχείο;
Χρησιμοποιήστε την επαναλαμβανόμενη ερώτηση, το κατάλληλο προϊόν, την εγκεκριμένη πηγή, την αντιστοίχιση ορολογίας, τον υπεύθυνο ελέγχου και τη διαδικασία αλλαγών. Διαχωρίστε επαληθευμένα αναγνωριστικά, παρατηρήσεις και ανεπίλυτα ερωτήματα, ώστε ο επόμενος υπεύθυνος να επιλέξει την κατάλληλη πηγή.
Πώς πρέπει να αντιμετωπίζεται μια άγνωστη λεπτομέρεια προϊόντος;
Σημειώστε την ελλείπουσα λεπτομέρεια ως άγνωστη και διατηρήστε ορατό τον υπεύθυνο επαλήθευσής της. Χρησιμοποιήστε τη διαθέσιμη επαναλαμβανόμενη ερώτηση και τις καταγραφές πηγής για να καθορίσετε το πλαίσιο πριν παρουσιάσετε απάντηση συγκεκριμένη για το προϊόν.
Πώς μπορεί η Viflux να βοηθήσει σε αυτή τη ροή εργασίας;
Φέρτε ένα προϊόν και την εγκεκριμένη πηγή για μια επαναλαμβανόμενη ερώτηση. Μια στοχευμένη επίδειξη μπορεί να δείξει πώς επισημασμένο οπτικό υλικό, ελεγμένα βήματα ή σαφέστερη καταγραφή υποστήριξης βοηθούν στην επαναλαμβανόμενη ερώτηση και στο κατάλληλο προϊόν. Συμφωνήστε την προετοιμασία και τον έλεγχο πριν επεκτείνετε την εμπειρία.
Ξεκινήστε με ένα προϊόν και μια επαναλαμβανόμενη ερώτηση
Στείλτε το εγκεκριμένο εγχειρίδιο, τα διαγράμματα ή τις φωτογραφίες που έχετε ήδη. Ζητήστε μια δωρεάν επίδειξη οδηγού, ώστε η ομάδα σας να εξετάσει μια εργασία προϊόντος πριν αποφασίσει πώς θα την επεκτείνει.
Ένα προϊόν και η ισχύουσα αναθεώρησηΥπάρχουσα εγκεκριμένη τεκμηρίωσηΜια εργασία ή επαναλαμβανόμενη ερώτηση υποστήριξης