SDB:Howto
Περιεχόμενα
Περίπτωση
Αυτό το άρθρο SDB (βάση υποστήριξης) εξηγεί πώς να γράψετε άρθρα SDB.
Διαδικασία
Τα άρθρα SDB γράφονται για να δίνουν λύσεις σε προβλήματα με το openSUSE, αλλά επίσης και πιο λεπτομερείς εξηγήσεις σε ορισμένα θέματα. Αν έχετε προβλήματα με το openSUSE, η SDB θα πρέπει να είναι το πρώτο μέρος που θα αναζητήσετε βοήθεια.
Ένα άρθρο SDB πρέπει να χωρίζεται στα ακόλουθα τμήματα:
- Περίπτωση
- Διαδικασία
- Σύνδεσμοι
ή
- Σύμπτωμα
- Αιτία
- Λύση
- Σύνδεσμοι
Σημειώστε ότι τα άρθρα SDB – αν είναι δυνατόν – θα πρέπει πάντα να περιγράφουν την πιο εύκολη λύση. Ωστόσο, είναι επιθυμητό να δείχνετε επίσης και την πιο γρήγορη λύση μέσω τερματικού ή πειράζοντας αρχεία ρυθμίσεων. Σε αυτή την περίπτωση, το τμήμα “Λύση” πρέπει να χωριστεί σε διάφορα κομμάτια. Πριν μπούμε σε λεπτομέρειες σχετικά με τη σύνταξη, εδώ είναι ένα παράδειγμα: (το πρότυπο Template:SDB_article είναι διαθέσιμο όταν δημιουργείτε ένα νέο άρθρο SDB)
Δημιουργώντας ένα νέο άρθρο
Στον περιηγητή σας, εισάγετε τον τίτλο του νέου άρθρου μετά το SDB: στη γραμμή του URL. Αν το άρθρο δεν υπάρχει ήδη, κάντε κλικ στο "επεξεργασία" για να το δημιουργήσετε και να το επεξεργαστείτε.
Όλα τα άρθρα SDB πρέπει να ξεκινούν με το SDB:, αυτό κάνει ευκολότερη την αναζήτησή τους και δημιουργεί ένα ξεχωριστό τμήμα στο Wiki.
Μεταφράσεις
Προς το παρόν το wiki του openSUSE υποστηρίζει πολλαπλές γλώσσες. Αν θέλετε, και γνωρίζετε κάποια από αυτές, μεταφράστε το άρθρο σας. Αν όχι, ή δεν είστε σίγουροι αν έχετε αρκετή ευχέρεια στην ξένη γλώσσα, αφήστε ένα μήνυμα στη λίστα ηλεκτρονικού ταχυδρομείου του opensuse-wiki και ζητήστε από κάποιον να μεταφράσει το άρθρο σας.
Αν μεταφράσετε ένα άρθρο, προσθέστε τους συνδέσμους "Interwiki" στο τέλος του άρθρου. Ως παράδειγμα, αν έχετε μεταφράσει ένα άρθρο από τα Γερμανικά στα Αγγλικά, προσθέστε το ακόλουθο στο τέλος του Γερμανικού άρθρου:
[[en:SDB:<articlename>]]
Στην αγγλική έκδοση, προσθέστε το ακόλουθο:
[[de:SDB:<articlename>]]
Αλλάζοντας υπάρχοντα άρθρα
Ο χώρος του SDB βρίσκεται στη διαδικασία αναθεώρησης που κάνουμε. Αν επεξεργαστείτε ένα άρθρο οι αλλαγές σας θα αναθεωρηθούν και θα γίνουν ορατές σε όλους τους χρήστες μετά την αναθεώρηση.
Κατηγορίες
Κάθε άρθρο SDB πρέπει να είναι προσβάσιμο μέσω των κατηγοριών. Μπορείτε να βρείτε μια λίστα των διαθέσιμων κατηγοριών στο Category:SDB. Προσθέστε τις κατηγορίες στην αρχή του άρθρου:
[[Category:SDB:8.0|C]] [[Category:SDB:Network|C]]
Η κατηγορία ακολουθείτε από ένα χαρακτήρα σωλήνωσης και τον πρώτο χαρακτήρα του άρθρου. Στο παραπάνω παράδειγμα, το άρθρο ονομάζεται "Αλλάζοντας Διακομιστές NTP", οπότε ο χαρακτήρας σωλήνωσης ακολουθείτε από ένα "C".
Σύνταξη
Διαβάστε τις οδηγίες για το στυλ του wiki μας για να έχετε μια άποψη του πώς να μορφοποιείτε το περιεχόμενο.
Στυλ
Πώς να απευθύνεστε στους αναγνώστες σας
Τα Γερμανικά άρθρα SDB πρέπει να χρησιμοποιούν την ευγενική μορφή διεύθυνσης με το "Sie", καθώς αυτό είναι και το πρότυπο στην τεχνική τεκμηρίωση. Αν αυτό εφαρμόζεται στη γλώσσα σας, χρησιμοποιήστε την ευγενική μορφή επίσης. Οι Άγγλοι συγγραφείς φυσικά δεν έχουν αυτό το πρόβλημα ;-).
Ορολογία στις ξένες γλώσσες
Σε γλώσσες εκτός των Αγγλικών, είναι μερικές φορές δύσκολο να προχωρήσετε χωρίς την αγγλική ορολογία. Προσπαθήστε να γράψετε με τέτοιο τρόπο ώστε η ευρύτερη ομάδα χρηστών της SDB να βρουν το άρθρο σας χρήσιμο, αλλά μην προσπαθείτε να βρείτε μεταφράσεις ορολογίας όταν ο Αγγλικός όρος είναι ευρέως γνωστός και κατανοητός. Μια καλή πρακτική είναι να χρησιμοποιείτε και τους δύο όρους, όπως σε αυτό το γερμανικό παράδειγμα: "gehen Sie auf die zweite console (Kommandozeile) mit STRG-ALT-F2"
Εύκολο!
Ακόμα και η χρήση του κελύφους μερικές φορές φαίνεται ευκολότερη, ειδικά για εσάς, έχετε κατά νου όμως τους αρχάριους στο Linux και εξηγήστε επίσης πώς το πρόβλημα μπορεί να επιλυθεί με το YaST2 ή άλλα εργαλεία.
Ένα καλό άρθρο SDB πρέπει να περιγράφει κάθε βήμα ή να συνδέει σε κάποιο άλλο άρθρο όπου η συγκεκριμένη εξήγηση παρέχεται. Έτσι, μη γράφετε:
Στο /etc/inittab, αλλάξτε το προεπιλεγμένο runlevel στο 3.
αλλά:
Μπείτε στο σύστημα ως χρήστης root και ανοίξτε το αρχείο /etc/inittab με τον επεξεργαστή της επιλογής σας (π.χ. vi ή pico). Αλλάξτε τη γραμμή id:5:initdefault: σε id:3:initdefault: ώστε το σύστημα να μην εκκινεί σε γραφικό περιβάλλον πλέον.
Αυτό δεν έχει στόχο να είναι μια σκληρή απαίτηση! Απλά να θυμάστε ότι πολλοί αρχάριοι χρήστες Linux χρησιμοποιούν επίσης το openSUSE.
Συντήρηση
Είναι συχνά απαραίτητο να προσαρμόσετε τα άρθρα SDB στις νέες εκδόσεις του openSUSE, ή ακόμα να γράφετε νέα αν οι αλλαγές είναι ουσιώδεις. Προσπαθήστε να συντηρείτε τα δικά σας άρθρα SDB. Για παράδειγμα, αν παρατηρήσετε ότι το άρθρο σας δεν εφαρμόζεται πλέον με την τελευταία έκδοση του openSUSE, αλλάξτε τη γραμμή "έκδοση".