Η τεκμηρίωση του συστήματος αποτελείται από γραπτό υλικό που χρησιμοποιείται για την περιγραφή των εφαρμογών ενός υλικού υπολογιστή ή ενός συστήματος λογισμικού. Η τεκμηρίωση μπορεί να εμφανιστεί ως έντυπα εγχειρίδια, κάρτες flash, ιστοσελίδες ή κείμενο βοήθειας στην οθόνη. Η τεκμηρίωση του συστήματος είναι ζωτικής σημασίας για την επιτυχία οποιουδήποτε συστήματος υπολογιστών. Ωστόσο, πολλοί προγραμματιστές δυσκολεύονται να δημιουργήσουν επαρκή τεκμηρίωση για τα προϊόντα τους. Οι διαφορετικοί τύποι τεκμηρίωσης έχουν διαφορετικούς στόχους, οπότε το περιεχόμενο οποιασδήποτε τεκμηρίωσης θα εξαρτηθεί από το κοινό που επιθυμεί.
Τεκμηρίωση Έργου
Ο σκοπός της τεκμηρίωσης του έργου περιγράφει το έργο στο σύνολό του. Η τεκμηρίωση του έργου δίνει σε στελέχη, διευθυντικά στελέχη και υπαλλήλους ευρεία άποψη των μεθόδων, των πόρων και των στόχων του έργου. Τα έγγραφα της πρότασης έργου δείχνουν στους διευθυντές τους στόχους και τον προϋπολογισμό του έργου. Οι τεχνικές προδιαγραφές περιγράφουν τις απαιτήσεις υλικού και λογισμικού για τα έργα. Το σχέδιο του σχεδίου περιγράφει λεπτομερώς τα βήματα που θα λάβουν οι προγραμματιστές, οι τεχνικοί και οι σχεδιαστές για να επιτύχουν τους στόχους του έργου.
Δοκιμή τεκμηρίωσης
Τα έγγραφα δοκιμής απεικονίζουν τα σχέδια για τη δοκιμή του προϊόντος πριν από την απελευθέρωσή του. Το τμήμα διασφάλισης ποιότητας αναπτύσσει σχέδια δοκιμών τόσο για εσωτερικούς χρήστες "alpha" όσο και για εξωτερικούς δοκιμαστές "βήτα".Η τεκμηρίωση δοκιμής περιλαμβάνει οδηγίες δοκιμής - όπως ένα συγκεκριμένο σύνολο βημάτων που πρέπει να ακολουθήσουν οι δοκιμαστές - για να διαπιστωθεί εάν το προϊόν λειτουργεί όπως έχει προγραμματιστεί. Οι υπάλληλοι του QA συλλέγουν επίσης αρχεία καταγραφής προβλημάτων, λίστες σφαλμάτων και αναφορές από τους δοκιμαστές.
Ομάδα τεκμηρίωσης
Η ανταλλαγή ιδεών μεταξύ των μελών της ομάδας είναι ζωτικής σημασίας για την επιτυχία ενός έργου. Η τεκμηρίωση της ομάδας καταγράφει αυτές τις ανταλλαγές για χρήση στο τρέχον έργο και σε μελλοντικά έργα. Τα σχέδια ομάδας, τα χρονοδιαγράμματα και οι ενημερώσεις κατάστασης αποτελούν βασικά στοιχεία της τεκμηρίωσης της ομάδας. Οι λίστες ελέγχου βοηθούν τους διαχειριστές του έργου να δουν ποιες εργασίες έχει ολοκληρώσει η ομάδα. Τα πρακτικά των συναντήσεων ομάδων επιτρέπουν στους διαχειριστές να παρακολουθούν διάφορα θέματα, προτάσεις και αναθέσεις μεταξύ των μελών της ομάδας.
Τεκμηρίωση χρήστη
Το πιο κρίσιμο στοιχείο της τεκμηρίωσης του συστήματος είναι το περιεχόμενο που φτάνει στον πελάτη. Η τεκμηρίωση του χρήστη πρέπει να είναι απαλλαγμένη από υπερβολικά τεχνική φρασεολογία και να περιέχει σαφή και συνοπτική γλώσσα. Το εγχειρίδιο χρήσης είναι συνήθως το κύριο συστατικό της τεκμηρίωσης χρήστη, αλλά οι χρήστες βασίζονται επίσης σε άλλες πηγές. Οι πόροι κατάρτισης - συμπεριλαμβανομένων των εγχειριδίων και των βίντεο - μπορούν να βοηθήσουν τους χρήστες γρήγορα και εύκολα να κατανοήσουν πώς λειτουργεί το σύστημα. Όταν το σύστημα δεν λειτουργεί όπως αναμένεται, ένας οδηγός αντιμετώπισης προβλημάτων μπορεί να βοηθήσει τον χρήστη να βρει και να λύσει το πρόβλημα.
