Skip to main content

Τι είναι η τεκμηρίωση λογισμικού;

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

Τυπωμένη τεκμηρίωση λογισμικού, μερικές φορές αναφέρεται ως εγχειρίδια λογισμικού, συχνά δημιουργούνται σαν ένα βιβλίο, με μια σελίδα τίτλου, πίνακα περιεχομένων, σώματος και ευρετηρίου και συχνά έχουνΜερικά τυπικά στοιχεία.Το πρώτο στοιχείο που χρειάζονται οι περισσότεροι χρήστες είναι ένας οδηγός εγκατάστασης και δίνονται ξεχωριστοί οδηγοί για τα διάφορα λειτουργικά συστήματα που λειτουργεί το λογισμικό, ανάλογα με τις ανάγκες.Ο οδηγός εγκατάστασης απαριθμεί τις προδιαγραφές που απαιτούνται για την εκτέλεση του λογισμικού, συμπεριλαμβανομένων των λειτουργικών συστημάτων υπολογιστών, της μνήμης RAM, του χώρου σκληρού δίσκου, της σύνδεσης στο διαδίκτυο και οποιωνδήποτε άλλων απαιτήσεων ή πρόσθετων, όπως περιφερειακά.Αυτό ακολουθείται με οδηγίες βήμα προς βήμα για την εγκατάσταση, οι οποίες μπορεί να προέρχονται από ένα CD-ROM, ένα DVD ή μια λήψη, για παράδειγμα.Οποιεσδήποτε ασυνήθιστες λειτουργίες του εγκαταστάτη και η εξήγηση των προσαρμοσμένων επιλογών εγκατάστασης, όπως εναλλακτικές τοποθεσίες ή εξορθολογισμένες εγκαταστάσεις, εξηγούνται γενικά.

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

Άλλα στοιχεία που θα περίμενε κανείς να βρεθεί στην έντυπη τεκμηρίωση λογισμικού περιλαμβάνει μια πλήρη κατάρρευση των χαρακτηριστικών, με έμφαση στα χαρακτηριστικά νέα στην τελευταία έκδοση.μια λίστα ενημερώσεων από τις προηγούμενες εκδόσεις, ενδεχομένως, συμπεριλαμβανομένων των σφαλμάτων που έχουν καθοριστεί.Πληροφορίες σχετικά με τον τρόπο λήψης τεχνικής υποστήριξης ·Επεξηγήσεις μηνυμάτων σφάλματος.και πληροφορίες για χρήστες προηγμένου ή "power".Τα παιχνίδια και άλλες εφαρμογές λογισμικού ενδέχεται να περιλαμβάνουν εξαπάτηση ή συμβουλές στην τεκμηρίωση τους.

Η τυπωμένη τεκμηρίωση λογισμικού δεν είναι το μόνο είδος.Πρώτα απ 'όλα, η τυπωμένη τεκμηρίωση μπορεί επίσης να είναι διαθέσιμη online ή ως PDF.Πρόσθετη τεκμηρίωση μπορεί επίσης να είναι διαθέσιμη με τη μορφή συμβουλών εργαλείων και οθόνες βοήθειας στην ίδια την εφαρμογή, FAQS MDASH;Οι λίστες των συχνών ερωτήσεων μαζί με απαντήσεις, άρθρα που μπορούν να αναζητηθούν, κατάρτιση στο διαδίκτυο, βίντεο και άλλες μορφές.

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