Πώς να γράψετε Λογισμικό Τεκμηρίωση

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

Παρουσίαση Περισσότερες οδηγίες
Διαφορετικά είδη τεκμηρίωση του λογισμικού
Η 1

Γράψτε ό, τι κάνει το λογισμικό . Μετά την ανάγνωση αυτού του εγγράφου, ο αναγνώστης θα πρέπει να είναι σε θέση να καθορίσει αν χρειάζεται το λογισμικό . Να είστε βέβαιος να περιλαμβάνουν όλες τις δυνατότητες , που πολλές φορές μπορεί να είναι μια λίστα με όλες τις λειτουργίες του λογισμικού . 2

Εξηγήστε πώς οι λειτουργίες του λογισμικού σε σχέση με άλλα κομμάτια του λογισμικού . Αυτό μπορεί να αναφέρω άλλα κομμάτια του λογισμικού που θεωρούνται competitors.Be φροντίστε να περιγράψει τι είναι αυτό το κομμάτι του λογισμικού κάνει διαφορετικά από τους άλλους .
Εικόνων 3

Περιγράψτε τους τύπους των διεπαφών και τον κωδικό που χρησιμοποιούνται στο λογισμικό. Αυτή η ενότητα θα πρέπει να αφήσει τον αναγνώστη γνωρίζουν τι είδος των γνώσεων που ένας χρήστης θα πρέπει να είναι υποχρεωμένοι να εργάζονται με αυτό το κομμάτι του λογισμικού . Αυτό το μέρος της τεκμηρίωσης του λογισμικού που χρησιμοποιείται από προγραμματιστές και άλλους τεχνικούς ανθρώπους .
Η 4

Κάντε ένα έγγραφο για τον χρήστη του λογισμικού, έτσι ώστε όποιος το διαβάσει θα είναι σε θέση να αρχίσετε να χρησιμοποιείτε το πρόγραμμα . Αυτοί οι τύποι των εγγράφων μπορεί να είναι tutorials . Μπορούν επίσης να είναι λίστες εντολών ή ευρετήρια όπου οι χρήστες μπορούν να βρουν τις σχετικές πληροφορίες .
5

Γράψτε τεκμηρίωση ότι οι πωλητές μπορούν να χρησιμοποιήσουν όταν πωλούν το software.Make ότι έχετε συμπεριλάβει όλα τα ικανότητες και σημεία πώλησης του λογισμικού .
Η
εικόνων