Συμβουλές για καλό στυλ

1. Δομή σελιδών

• Να ξεκινάττε την σελίδα σας με μια κεφαλίδα πρώτου επιπέδου που να έχει ουσιώδη περιεχόμενο.
• Να ιεραρχείτε τα επίπεδα των κεφαλίδων με τον σωστό τρόπο. τα δευτερέυοντα τμήματα θα πρέπει να έχουν κεφαλίδες δευτέρου επιπέδου.
• Να οργανώνετε το κείμενο σας σε παραγράφους με την προσθήκης μιας κενής γραμμής ανάμεσά τους. Μια μέσου μήκους παράγραφος δεν πρέπει να έχει πάνω από 10-20 γραμμές.
• Αν το κείμενο σας είναι μεγαλύτερο από κάμποσες (3-5) παραγράφους, σκεφτείτε το ενδεχόμενο να το οργανώσετε σε τμήματα με την προσθήκη κεφαλίδων δευτέρου ως πεμπτου επιπέδου.
• Όταν το κείμενο σας φτάσει να εκτείνεται σε 2-3 οθόνες, να βάζετε μια σύντομη περίληψη αμέσως μετά την πρώτη κεφαλίδα της σελίδας. Όταν η σελίδα σας φτάνει να είναι αισθητά πιο μακροσκελής, σκεφτείτε το ενδεχόμενο να την διαχωρίσετε σε περισσότερες από μια.
• Αν έχετε πολλούς συνδέσμους σε άλλες σελίδες του wiki ή εξωτερικές πηγές, προσθέστε ένα τμήμα που να αναφέρει περαιτέρω αναφορές (βλ.παρακάτω).
• Αν οι περισσότερες σελίδες ενός φακέλου χρησιμοποιούν όμοια δομή, προσθέστε ένα πρότυπο φακέλου έτσι ώστε κάθε νέα σελίδα να ξεκινά με αυτό το πρότυπο ως σκελετό για την δομή της.
• Προσπαθήστε να αποφύγετε πάρα πολύ σύνθετες δομές φακέλων (namespaces). Προσπαθήστε να χρησιμοποείτε σύντομα και ευκολομνημόνευτα όνοματα φακέλων (namespaces).

2. Μορφοποίηση κειμένου

• Για να δώσετε έμφαση σε απομονωμένες λέξεις ή φράσεις να κάνετε χρήση έντονου κειμένου ή πλάγιας γραφής. Επιλέξτε ένα από τα δυο και διατηρήστε το σε όλο το wiki.
• Επιλέξτε μια μορφοποίηση για να αναπαριστά κείμενο οθόνης και κείμενο επί οθόνης όπως κουμπιά και μενού και χρησιμοποιείτε του με συνέπεια και ομοιογένεια σε όλο το περιεχόμενο του wiki σας. Μπορεί να είναι καλή ιδέα το να δημιουργήσετε μια σελίδα που να εξηγεί όλες της συμβάσεις μορφοποίησης που χρησιμοποιούνται στο wiki σας.
• Κάντε χρήση μη αριθμημένων λιστών για προτάσεις που είναι ανεξάρτητες μεταξύ τους. Αν αναπτύσσετε μια σειρά από έννοιες, διαμορφώστε τις σε συνεχόμενες προτάσεις.
• Κάντε χρήση υποσημειώσεων σπάνια και μόνο για σύντομες πληροφορίες. Αν πρέπει να πείτε πολλά για ένα θέμα βάλτε το σε μια άλλη σελίδα wiki. Αν θέλετε να κάνετε αναφορά σε εξωτερικές πηγές πληροφοριών καλύτερα να κάντε χρήση συνδέσμων.
• Η χρήση πινάκων μπορεί να ενισχύσει την αναγνωσιμότητα των δεδομένων. Αν εισάγετε έναν πίνακα, να συμπεριλαμβάνετε μια λεζάντα που να συνοψίζει τα περιεχόμενα του πίνακα (π.χ. “Πίνακας 1.2: Μέσες αποστάσεις μεταξύ πλανητών”) και φροντίστε ο πίνακας να έχει ουσιώδεις κεφαλίδες.
• Οι μακροσκελείς πίνακες μπορεί να παρουσιάζουν δυσκολίες κατά την επεξεργασία τους. Σκεφτείτε το ενδεχόμενο να παρουσιάσετε τα δεδομένα σας σε ιεραρχικές λίστες.

3. Ύφος

• Να γράφετε κανονικές και πλήρεις προτάσεις κάνοντας σωστή χρήση άρθρων και ουσιαστικών όποτε είναι απαραίτητα.
• Ξεκινάτε κάθε πρόταση με κεφαλαίο γράμμα και τελειώνετε την με τελεία ή άλλο κατάλληλο σημείο στίξης.
• Προσπαθήστε να γράφετε σύντομες, ξεκάθαρες προτάσεις, αποφεύγοντας τις δευτερεύουσες προτάσεις. Όταν πιστεύετε ότι έχετε τελειώσει την σελίδα σας, διαβάστε την ξανά και διορθώστε τις όποιες σύνθετες προτάσεις.
• Αποφασίστε πως θα απευθύνεστε στους αναγνώστες σας. Εφόσον το Wiki είναι προσανατολισμένο στην συγγραφή τεκμηρίωσης συχνά θα χρειαστεί να υποδείξετε στους αναγνώστες σας να κάνουν κάποια πράγματα. Μπορείτε να χρησιμοποιήσετε προστακτική (“Διαβάστε αυτό!”), πρώτο ή δεύτερο πληθυντικό (“Μετά πάμε/πάτε να διαβάσετε […]”) ή απλό πρώτο πρόσωπο (“Εγώ μετά διάβασα […]”). Μην μπλέκετε τα πρόσωπα.
• Ελέγξτε την σελίδα σας για γραμματικά ή ορθογραφικά σφάλματα πριν την αποθηκεύσετε. Αν το κείμενο σας περιέχει πολλά λάθη, θα μειώσει την αξιοπιστία των λεγόμενων σας, ανεξάρτητα από το πόσο καλή διατύπωση ή καλή απόδοση έχουν.
• Αναπτύξτε το δικό σας χαρακτήρα. Μην επιβάλλετε στον εαυτό σας να γράφει με τρόπο που δεν σας βολεύει. Θα σας φαίνεται πάντοτε αφύσικο και ανυπόφορο κατά την ανάγνωση.

4. Αναφορές

• Όταν συναντάτε έναν όρο που θέλει περαιτέρω εξήγηση, προσθέστε μια νέα σελίδα wiki για τον όρο και συνδέστε τον.
• Επανελέγξτε την σελίδα σας πριν την τελειώσετε, και προσθέστε συνδέσμους σε υπάρχουσες σελίδες wiki στους κύριους όρους της.
• Μην προσθέτετε συνδέσμους σε όλες τις εμφανίσεις συγκεκριμένων όρων που έχουν σελίδες. Κάντε μονάχα την πρώτη πιο εμφανή περίπτωση του όρου σύνδεσμο και ίσως να τον προσθέσετε και στο κομμάτι της σελίδας που περιέχει συγκεντρωμένες της αναφορές.
• Να παρέχετε συνδέσμους σε πηγές εικόνων, δεδομένων και παραθέσεων.
• Λάβετε υπόψιν σας το ενδεχόμενο να προσθέσετε μια γραμμή “Δείτε και:” στο τέλος της σελίδας σας. Παρέχετε συνδέσμους που είναι στενά συνδεδεμένοι με το αντικείμενο της σε αυτή την γραμμή.
• Αν θέλετε να δώσετε εξωτερικές πηγές που έχουν επιπλέον πληροφορίες για το θέμα ή που χρησιμοποιήσατε για να γράψετε την σελίδα σας, προσθέστε ένα τμήμα με το όνομα “Αναφορές” ή “Περισσότερες πληροφορίες” στο τέλος της και δώστε μια λίστα συνδέσμων ή άλλες ενδείξεις (π.χ. αριθμούς ISBN). Αν αν δεν το έχετε ήδη εκφράσει στο κυρίως κείμενο, αναφέρετε και την πρόθεση της αναφοράς.
• Η χρήση συντομεύσεων interwiki μπορεί να βοηθήσει με τους συνδέσμους σε συχνές πηγές.

5. Εικόνες και άλλα πολυμέσα

• Το “Μια εικόνα είναι χίλιες λέξεις” μπορεί να σημαίνει ότι λέει παραπάνω από όσα θέλατε να πείτε. Οι άνθρωποι έχουν την τάση να ρωτούν πιο πολύ για την αυθεντικότητα των εικόνων παρά αυτή των κειμένων. Μια σύντομη λεκτική περιγραφή είναι πολύ καλύτερη από το τίποτα ή από μια ανακριβή εικόνα.
• Όπως και στους πίνακες, να δίνετε λεζάντες στις εικόνες σας που να συγκεκριμενοποιεί τι θέλετε να δείξετε με την εικόνα.
• Αν δεν δημιουργήσατε μόνος σας την εικόνα, να αναφέρετε την πηγή (πιθανότατα με έναν σύνδεσμο) και την άδεια πνευματικών δικαιωμάτων.
• Μην συνδέετε εικόνες από εξωτερικούς ιστότοπους, εκτός και αν σας επιτρέπεται ρητά κάτι τέτοιο. Αυτό είναι εν μέρει θέμα πνευματικών δικαιωμάτων, αλλά μπορεί να είναι και θέμα κλοπής bandwidth όταν η cache μνήμη για εξωτερικές εικόνες είναι απενεργοποιημένη.
• Αν η εικόνα καταλαμβάνει περίπου το ένα τρίτο της οθόνης, χρησιμοποιήστε την δυνατότητα μεγέθυνσης για να την εισάγετε με μειωμένες διαστάσεις.