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