10 βήματα για να γράψετε ένα βόηθημα

Ανακοινώσεις και νέα σχετικά με την σελίδα μας.

Συντονιστής: Super-Moderators

Απάντηση
Άβαταρ μέλους
manolism
Super Moderator
Δημοσιεύσεις: 6652
Εγγραφή: 25 Ιαν 2004 16:01
Τοποθεσία: Wild West
Επικοινωνία:

10 βήματα για να γράψετε ένα βόηθημα

Δημοσίευση από manolism » 25 Μάιος 2010 11:25

Κάνοντας μία βόλτα από τη σελίδα των βοηθημάτων του Freestuff διαπίστωσα ότι υπάρχουν 845 βοηθήματα σε όλες τις κατηγορίες και συνεχώς αυξάνονται. Κάτι τέτοιο δεν θα μπορούσε να γίνει χωρίς τη βοήθεια των διαχειριστών, των συντονιστών και των μελών του Freestuff. Αλλά πως γράφουμε ένα βοήθημα; Θα προσπαθήσω με βάση τη δική μου εμπειρία να φτιάξω ένα οδηγό για όποιον ενδιαφέρεται να ασχοληθεί με το «άθλημα».

1. Τα βοηθήματα γράφονται για αρχάριους και με βάση αυτούς πρέπει να τα περιγράφουμε. Εάν ήταν γνώστες δεν θα χρειαζόταν καν να ακολουθήσουν το βοήθημά μας. Θα το πάλευαν μόνοι τους.

2. Εφόσον απευθυνόμαστε σε Έλληνες γράφουμε πάντα σε Ελληνικά και μάλιστα σωστά Ελληνικά. Χωρίς ορθογραφικά και συντακτικά λάθη, χωρίς ασυναρτησίες, μισές λέξεις κ.λπ. Έτσι σεβόμαστε τον αναγνώστη και κάνουμε την ανάγνωση του βοηθήματος πιο εύκολη.

3. Φροντίζουμε μαζί με την περιγραφή να έχουμε συνοδευτικό υλικό όπως εικόνες των βημάτων, εικόνες του τελικού αποτελέσματος, live demo εάν πρόκειται για βοήθημα που περιέχει κώδικα, video ή οτιδήποτε άλλο. Επίσης καλό είναι να δίνουμε σε ένα zip όλα τα αρχεία που θα χρειαστούν για να εκτελεστεί το βοήθημα.

4. Όσο πιο πολλά βήματα και ανάλυση τόσο πιο επιτυχημένο είναι το βοήθημα. Μην κρίνεται το βοήθημα με βάση τον εαυτό σας που το ξέρετε. Ο αναγνώστης χρειάζεται το βοήθημα και όχι εσείς.

5. Εάν το βοήθημα περιέχει κώδικα τον περιβάλουμε με το αντίστοιχο bbcode ώστε να είναι ευανάγνωστος. Επίσης τον κώδικα που δίνουμε καλό είναι να λέμε ακριβώς σε ποιο αρχείο μπαίνει και σε ποιο σημείο. Ο αναγνώστης δεν είναι μάντης για να δει στη γυάλινη σφαίρα τι το κάνει αυτό που βλέπει μπροστά του.

6. Εάν το βοήθημα είναι καθαρά θεωρητικό καλό είναι να δίνουμε links με σχετικά θέματα ώστε ο αναγνώστης να μπορεί να διευρύνει τις γνώσεις του.

7. Φροντίζουμε το αποτέλεσμα του βοηθήματος να είναι σωστό. Για να το πετύχουμε αυτό πρώτα το εκτελούμε εμείς και μετά το δημοσιεύουμε.

8. Δεν παρουσιάζουμε ως δικά μας βοηθήματα που έχουμε μεταφράσει. Αν αποφασίσουμε να μεταφράσουμε ένα βοήθημα, το εκτελούμε μόνοι μας, κόβουμε τις δικές μας εικόνες, προσθέτουμε τα δικά μας σχόλια και τέλος δίνουμε ένα link προς αυτόν που εμπνεύστηκε το βοήθημα. Πάντα υπάρχει ο κίνδυνος το ξένο βοήθημα να είναι λάθος και να γίνουμε εμείς ρεζίλι.

9. Εννοείται ότι δεν κλέβουμε άλλα βοηθήματα από άλλες Ελληνικές σελίδες. Υποτιμούν και τη νοημοσύνη του αναγνώστη αλλά κυρίως βλάπτει το νέο χώρο που τα δημοσιεύουμε.

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

Υπόδειγματα βοηθημάτων στο Freestuff

http://www.freestuff.gr/forums/viewtopic.php?t=43448
http://www.freestuff.gr/forums/viewtopic.php?t=17333
http://www.freestuff.gr/forums/viewtopic.php?t=18243

και πολλά άλλα. Σχόλια αλλά και προσθήκες ευπρόσδεκτα :D

Άβαταρ μέλους
inFamous
Δημοσιεύσεις: 388
Εγγραφή: 07 Φεβ 2010 12:38
Επικοινωνία:

10 βήματα για να γράψετε ένα βόηθημα

Δημοσίευση από inFamous » 25 Μάιος 2010 17:03

To δικό μου δεν σ'άρεσε :@

http://www.freestuff.gr/forums/viewtopic.php?t=48886


Πλακίζω εννοείται...
Πολύ σωστές οι υποδείξεις σου
Εικόνα

Απάντηση

Επιστροφή στο “Ανακοινώσεις”

Μέλη σε σύνδεση

Μέλη σε αυτήν τη Δ. Συζήτηση: Δεν υπάρχουν εγγεγραμμένα μέλη και 0 επισκέπτες