Project

General

Profile

Προδιαγραφές » History » Version 2

Yannis Exidaridis, 18/12/2013 14:40

1 2 Yannis Exidaridis
h1. Προδιαγραφές κώδικα
2 1 Yannis Exidaridis
3
Οι υποβολές των αλλαγών που γίνονται στο κώδικα θα πρέπει να τηρούν τις ακόλουθες προδιαγραφές:
4
5
*Συμβατότητα*
6
7
Διατήρηση της συμβατότητας με τα υπόλοιπα υποσυστήματα της πλατφόρμας.
8
Τυχόν αλλαγές που γίνονται στη βάση θα πρέπει να συνοδεύονται με πλήρη τεκμηρίωση των τυχόν καινούριων πινάκων/πεδίων της βάσης μαζί με το κατάλληλο script αναβάθμισης ενσωματωμένο στο _upgrade.php_.
9
10
*Τήρηση των κανόνων ασφαλείας*
11
12
Ιδιαίτερη προσοχή έτσι ώστε ο χρήστης/φοιτητής να μην μπορεί να εκτελεί ενέργειες που δεν επιτρέπονται. Ασφάλεια θα πρέπει να υπάρχει και στο "Διαχειριστικό Εργαλείο της Πλατφόρμας".
13
 
14
*Τεκμηρίωση*
15
16
Σύντομη τεκμηρίωση των λειτουργιών που προστίθονται/αλλάζουν καθώς και του αντίστοιχου κώδικα. Αν οι αλλαγές διορθώνουν κάποιο σφάλμα ή δυσλειτουργία, θα πρέπει να παρατίθεται αντίστοιχο παράδειγμα.
17
18
*Αντίστοιχο on-line help*
19
20
Κάθε καινούριο υποσύστημα θα πρέπει να συνοδεύεται από το αντίστοιχο on-line help. Επίσης, θα πρέπει να υπάρχουν περιγραφές του υποσυστήματος για ενσωμάτωσή του στα εγχειρίδια.
21
22
*Επιτυχημένη λειτουργία*
23
24
Είναι επιθυμητή η αναφορά επιτυχημένης λειτουργίας σε όσο το δυνατόν περισσότερες εκδόσεις λειτουργικών συστημάτων (π.χ. Windows XP/2000/2003/Vista/2007, UNIX/Linux) και εκδόσεων PHP (εκδόσεις >= 5.3), Apache (>= 2.x), MySQL (εκδόσεις >= 5.x.). Αν υπάρξουν τυχόν ασυμβατότητες σε συγκεκριμένες εκδόσεις PHP, Apache, MySQL (πάντα σε εκδόσεις μεγαλύτερες από τις προαναφερθέντες) θα πρέπει να αναφέρονται καθώς και να δικαιολογούνται.
25
 
26
*Συμβατότητα με τους δημοφιλέστερους browsers*
27
28
Ο καινούριος κώδικας θα πρέπει να είναι συμβατός με τους πιο δημοφιλείς browsers (π.χ. Internet Explorer εκδόσεις μεγαλύτερες του 7, τελευταίες εκδόσεις του Firefox κ.λπ.)