Ακολουθεί μια κατανομή του γιατί:
* αφηγηματική περιγραφή: Η τεκμηρίωση χρησιμοποιεί φυσική γλώσσα για να εξηγήσει τι κάνει ένα πρόγραμμα, πώς λειτουργεί και οι περιπτώσεις χρήσης που προορίζονται. Σκεφτείτε αυτό ως την "ιστορία" του λογισμικού.
* Γραφική περιγραφή: Για να διευκρινιστεί περαιτέρω, η τεκμηρίωση ενσωματώνει συχνά οπτικά όπως:
* Στιγμιότυπα: Παρουσιάζοντας τη διεπαφή του προγράμματος και πώς να το πλοηγηθείτε.
* Διαγράμματα: Απεικονίζει τις σχέσεις μεταξύ διαφορετικών τμημάτων του προγράμματος ή των διαδικασιών.
* Διαγράμματα ροής: Απεικονίζοντας τα λογικά βήματα μιας διαδικασίας μέσα στο πρόγραμμα.
* Οδηγός &Αναφορά: Η καλή τεκμηρίωση εξυπηρετεί τόσο ως οδηγό (διδάσκοντας τους χρήστες πώς να κάνουν πράγματα) όσο και ως αναφορά (παρέχοντας γρήγορες απαντήσεις σε συγκεκριμένες ερωτήσεις).
Διαφορετικές μορφές τεκμηρίωσης
Η τεκμηρίωση μπορεί να λάβει πολλές μορφές, ανάλογα με την πολυπλοκότητα του προγράμματος και το κοινό -στόχο:
* Εγχειρίδια χρήσης: Στοχεύεται στους τελικούς χρήστες, εστιάζοντας στον τρόπο χρήσης των χαρακτηριστικών του προγράμματος αποτελεσματικά.
* Τεκμηρίωση API: Για τους προγραμματιστές που θέλουν να ενσωματώσουν τη λειτουργικότητα του προγράμματος σε άλλες εφαρμογές.
* Τεχνική τεκμηρίωση: Προσανατολισμένη προς τους προγραμματιστές που εργάζονται στο ίδιο το πρόγραμμα, καλύπτοντας την αρχιτεκτονική του, τον κώδικα και τις εσωτερικές λειτουργίες.
* Διαδικτυακή βοήθεια: Ενσωματωμένο στο λογισμικό, προσφέροντας βοήθεια ευαίσθητη στο περιβάλλον στο περιβάλλον του προγράμματος.
* Tutorials: Βήμα προς βήμα οδηγοί που περπατούν στους χρήστες μέσω συγκεκριμένων εργασιών ή διαδικασιών.
Επιτρέψτε μου να ξέρω αν θα θέλατε να επεξεργαστώ σε οποιοδήποτε από αυτά τα είδη τεκμηρίωσης!
Πνευματικά δικαιώματα © Γνώση Υπολογιστών Όλα τα δικαιώματα κατοχυρωμένα