ΤΕΧΝΟΛΟΓΙΑ ΛΟΓΙΣΜΙΚΟΥ ΤΕΚΜΗΡΙΩΣΗ ΛΟΓΙΣΜΙΚΟΥ 18 Oκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού ΤΕΚΜΗΡΙΩΣΗ Λειτουργεί ως επικοινωνιακό μέσο μεταξύ των μελών της ομάδας ανάπτυξης λογισμικού αποθήκη πληροφοριών, στη διάθεση των μηχανικών συντήρησης του λογισμικού Παρέχει πληροφορίες που βοηθούν στο καλύτερο προγραμματισμό και χρηματοδότηση της διαδικασίας παραγωγής του λογισμικού. τους χρήστες να διαχειρίζονται και να χρησιμοποιούν το λογισμικό Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού ΕΙΔΗ ΤΕΚΜΗΡΙΩΣΗΣ Τεκμηρίωση διαδικασίας (process documentation) Τεκμηρίωση προϊόντος (product documentation) Τεκμηρίωση Χρήστη Τεκμηρίωση Συστήματος Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

ΤΕΚΜΗΡΙΩΣΗ ΔΙΑΔΙΚΑΣΙΑΣ Πλάνα (plans), προβλέψεις (estimations) και προγράμματα (schedules) Αναφορές Πρότυπα (standards) Φύλλα εργασίας (working papers) Σημειώματα και μηνύματα ηλεκτρονικού ταχυδρομείου Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

ΤΕΚΜΗΡΙΩΣΗ ΠΡΟΪΟΝΤΟΣ Τεκμηρίωση Χρήστη (1/2) Αφορά Τελικούς χρήστες και Διαχειριστές Λειτουργική περιγραφή του συστήματος Εισαγωγικό εγχειρίδιο Εγχειρίδιο αναφοράς του συστήματος Εγχειρίδιο εγκατάστασης του συστήματος Εγχειρίδιο του διαχειριστή του συστήματος Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

ΤΕΚΜΗΡΙΩΣΗ ΠΡΟΪΟΝΤΟΣ Τεκμηρίωση Χρήστη (2/2) Kατασκευαστές του συστήματος Διαχειριστές συστήματος Έμπειροι χρήστες Διαχειριστές συστήματος Νέοι χρήστες Λειτουργική περιγραφή Εγχειρίδιο εγκατάστασης Εισαγωγικό εγχειρίδιο Εγχειρίδιο αναφοράς Εγχειρίδιο διαχειριστή Περιγραφή των Παρεχόμενων υπηρεσιών Πώς θα εγκατασταθεί το σύστημα Εκκίνηση συστήματος Λεπτομέρειες όλων των λειτουργιών του συστήματος Πώς θα λειτουργήσει και θα συντηρηθεί το σύστημα Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

ΤΕΚΜΗΡΙΩΣΗ ΠΡΟΪΟΝΤΟΣ Τεκμηρίωση Συστήματος (1/2) Απαιτήσεις συστήματος Περιγραφή αρχιτεκτονικής Προδιαγραφή και περιγραφή του σχεδιασμού Λίστες με τον κώδικα των προγραμμάτων Έγγραφα επικύρωσης Οδηγός συντήρησης του συστήματος Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού ΠΟΙΟΤΗΤΑ ΤΕΚΜΗΡΙΩΝ Σημαντικότητα ποιότητας τεκμηρίων Τρόπος διασφάλισης ποιότητας εγγράφων Δομή τεκμηρίων: εξώφυλλο, κεφάλαια, ευρετήριο (index), γλωσσάρι (glossary) Πρότυπα τεκμηρίων: Πρότυπα διαδικασίας, Πρότυπα προϊόντος, Πρότυπα ανταλλαγής Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Υπόδειγμα Εξωφύλλου Collaborative Support for Systems Design ACTIVE DISPLAYS Title: Active Displays Project: MRC 842317 Document Identifier: CSSD/CS/WD/17 Document type: Technical working paper Version :1.2 Date : 20th December 1990 Author :Ian Sommerville Inspected: N/A. Approved: N/A Submitted to CM: CM identifier Distribution: Project list Confidentiality: Commercial Keywords: User interface,display update, agents  Lancaster University 1990 Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού Εισαγωγή μαθήματος Σκοπός Μορφή/Είδη εγγράφων που λειτουργούν ως: Επικοινωνιακό μέσο Χρήση κατά την συντήρηση του λογισμικού Διευκόλυνση διαδικασίας παραγωγής Εγχειρίδια για τους χρήστες Μέσα παραγωγής Τρόπος Διαχείρισης Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού Πρότυπα διαδικασίας Καθορίζουν τη διαδικασία που θα ακολουθηθεί για παραγωγή εγγράφων Oρίζονται τα εργαλεία λογισμικού που θα πρέπει να χρησιμοποιηθούν για τη παραγωγή του εγγράφου και οι διαδικασίες εξασφάλισης ποιότητας τους Η αναμενόμενη ποιότητα του εγγράφου είναι πάντα σε εξάρτηση με το τύπο του κειμένου και τους αναγνώστες στους οποίους απευθύνεται Π.χ. δεν απαιτείται έλεγχος της ποιότητας του εγγράφου όταν πρόκειται για ένα φύλλο εργασίας ή για μια απλή σημείωση, ενώ χρειάζεται ιδιαίτερη προσοχή όταν πρόκειται για ένα τυπικό έγγραφο που θα ελέγχεται από διαδικασίες διαχείρισης του συστήματος Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού Πρότυπα Προϊόντος Tα τεκμήρια που παράγονται κατά τη διάρκεια ανάπτυξης λογισμικού πρέπει να έχουν μία συνεπή εμφάνιση και αυτά της ίδιας κατηγορίας μια συνεπή δομή. Τα πρότυπα τεκμηρίων εξαρτώνται συνήθως από το συγκεκριμένο έργο, αλλά θα πρέπει να βασίζονται σε πιο γενικά οργανωτικά πρότυπα. Παραδείγματα τέτοιων προτύπων που πρέπει να αναπτυχθούν είναι: Πρότυπα Αναγνώρισης Εγγράφων (document identification standards) Πρότυπα Δομής Εγγράφων (document structure standards) Πρότυπα Παρουσίασης Εγγράφων (document presentation standards) Πρότυπα Ενημέρωσης Εγγράφων (document update standards) Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού Πρότυπα Τεκμηρίων Χρησιμοποιούνται για να εξασφαλιστεί η ποιότητα των τεκμηρίων. Κατηγοριοποιούνται ως εξής: Πρότυπα διαδικασίας. Ορίζουν τη διαδικασία που θα πρέπει να ακολουθηθεί ώστε να παραχθεί ποιοτικό έγγραφο Πρότυπα προϊόντος. Καθορίζουν πως να είναι τα ίδια τα τεκμήρια Πρότυπα ανταλλαγής. Εξασφαλίζουν τη συμβατότητα των ανταλλασσόμενων ηλεκτρονικών αντιγράφων Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού Πρότυπα Ανταλλαγής Καθορίζουν τους όρους χρήσης των εργαλείων Στα πρότυπα ανταλλαγής ορίζονται όλοι οι περιορισμοί και τα πρότυπα που θα πρέπει να υιοθετούνται κατά τη συγγραφή του αυθεντικού εγγράφου Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού Τύπος γραψίματος Χρήση ενεργητικής αντί παθητικής φωνής. Σωστή σύνταξη Η χρήση σωστών γραμματικών δομών και αποφυγή μεγάλων προτάσεων Μικρές παράγραφοι Συντομία στις περιγραφές Ακρίβεια στον ορισμό των όρων που χρησιμοποιούνται Αν κάποια περιγραφή είναι σύνθετη, επανάλαβε αυτό που θέλεις να πεις με διαφορετικό τρόπο. Η χρήση επικεφαλίδων και υπό-επικεφαλίδων Τα δεδομένα καλύτερα να παρατίθενται σε λίστα αντί σε μια πρόταση. Αν παραπέμπεις σε κάτι, μη χρησιμοποιείς μόνο το νούμερο του κεφαλαίου αλλά δώσε και μια περιγραφή της παραπομπής Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007

Για περισσότερες πληροφορίες..... http://eclass.di.uoa.gr/claroline/document/document.php Εισαγωγή – Μοντέλα Ανάπτυξης Λογισμικού 18 Οκτωβρίου 2007