Εγχειρίδιο του FreeCodeCamp Medium Publication Editor

Σημείωση: το freeCodeCamp δεν είναι πλέον ενεργό στο Medium. Τώρα χρησιμοποιούμε το δικό μας αυτο-φιλοξενούμενο εργαλείο ανοιχτού κώδικα Ghost blogging. Ίσως το διαβάζετε στο FreeCodeCamp News αυτή τη στιγμή; Ωστόσο, αυτό μπορεί να σας φανεί χρήσιμο εάν επιλέξετε να δημοσιεύσετε στο Medium.

Η κοινότητα ανοιχτού κώδικα openCodeCamp κάποτε εκτελούσε τη μεγαλύτερη τεχνική έκδοση του Medium. Κάθε εβδομάδα, δημοσιεύαμε περισσότερες από δώδεκα ιστορίες για την ανάπτυξη, το σχεδιασμό και την επιστήμη των δεδομένων.

Για μεγαλύτερο χρονικό διάστημα, υπηρέτησα ως ο μοναδικός συντάκτης της έκδοσης. Επεξεργαστήκα και δημοσίευσα περισσότερες από 1.200 υποβολές. Όμως, είχαμε πάντα περισσότερες υποβολές ιστοριών υψηλής ποιότητας από ό, τι είχα χρόνο να δημοσιεύσω. Έτσι, παραδέχτηκα τελικά ότι χρειάζομαι βοήθεια.

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

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

Έτσι, στις αρχές Ιουλίου, δημοσίευσα μια πρόσκληση για εθελοντές συντάκτες. Περισσότερα από 50 άτομα απάντησαν. Και από αυτούς τους ερωτηθέντες, συγκέντρωσα και εκπαίδευσα μια μικρή ομάδα συντακτών.

Ταυτόχρονα, συνέταξα τι θα γινόταν τελικά αυτό το Εγχειρίδιο επεξεργαστή. Αυτός είναι ο οδηγός μας για τον τρόπο με τον οποίο η ομάδα εθελοντών εκδοτών επεξεργάζεται ιστορίες. Και στο πνεύμα της διαφάνειας, το δημοσιοποιώ.

Μπορεί να σας φανεί χρήσιμο εάν επεξεργαστείτε ένα τεχνικό περιοδικό ή μια έκδοση Medium. Ή - εάν είστε ένας από τους 500+ συγγραφείς που έχουν δημοσιευτεί στη δημοσίευση του FreeCodeCamp - ίσως να είστε περίεργοι τι συμβαίνει στο παρασκήνιο.

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

Πώς αξιολογούμε, επεξεργαζόμαστε και δημοσιεύουμε ιστορίες

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

  • καλογραμμένο
  • σχετικό με το κοινό μας προγραμματιστών , σχεδιαστών και επιστημόνων δεδομένων
  • τεκμηριωμένο και όχι πρωτίστως γραμμένο για να διαφημίσετε ένα προϊόν ή μια εταιρεία

Η πραγματικότητα της δημοσίευσης άρθρων στον 21ο αιώνα

Οι άνθρωποι είναι απασχολημένοι. Δεν ήταν ποτέ πιο απασχολημένοι. Και τα πράγματα θα επιδεινωθούν προτού βελτιωθούν.

Πρέπει να βελτιστοποιήσουμε για τον περιορισμένο χρόνο των αναγνωστών μας.

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

Οι περισσότερες μεσαίες ιστορίες μοιάζουν περισσότερο με ιστορίες χαρακτηριστικών. Αφηγούνται εκδηλώσεις (postmortems έργου, αναφορές σχετικά με την απόκτηση εργασίας) ή υποστηρίζουν ένα σημείο (εκθέτοντας τρωτά σημεία ασφαλείας, υποστηρίζοντας τη χρήση μιας συγκεκριμένης βιβλιοθήκης για έναν συγκεκριμένο σκοπό).

Μια άλλη κατηγορία είναι τα μαθήματα. Αυτά μπορεί να αφορούν τα πάντα, από το πώς να διορθώσετε ένα αποσπασμένο κεφάλι στο Git, έως τον τρόπο δημιουργίας δεξιοτήτων Alexa χωρίς διακομιστή.

Ανεξάρτητα από τον τύπο της ιστορίας - ειδήσεις, χαρακτηριστικά, φροντιστήριο - όλοι πρέπει να αγωνίζονται για τις ίδιες αρετές:

  • Ουσία .Η ιστορία πρέπει να φέρει κάτι σημαντικό στο τραπέζι. Η ιστορία ενός συγγραφέα για το Commodore 64 που αγόρασαν οι γονείς τους για τη δεκαετία του 1980 μπορεί να τους ενδιαφέρει προσωπικά, αλλά θα έχει σημασία για έναν τυπικό αναγνώστη; Θα φύγουν με κάτι χρήσιμο; Από την άλλη πλευρά, σχεδόν όλοι οι αναγνώστες μας θα επωφεληθούν από την εκμάθηση περισσότερων για τη διαδικασία συνέντευξης εργασίας ή την καλύτερη κατανόηση του τρόπου λειτουργίας του CSS.
  • Προσβασιμότητα . Η ιστορία πρέπει να είναι όσο πιο εύκολη για να κατανοήσει ο λαός. Υπάρχουν πρακτικά όρια στο πόσο απλή μπορεί να είναι μια εξήγηση μιας μαθηματικής έννοιας, αλλά λίγοι συγγραφείς αρχίζουν ακόμη και να προσεγγίζουν τέτοια όρια. Ένας στοχαστικός επικοινωνιακός μπορεί να διοχετεύσει τον εσωτερικό του Αϊνστάιν ή τον Φέινμαν και να κάνει πολλές πολύπλοκες έννοιες σχετικά εύκολα κατανοητές. Αυτό όμως απαιτεί προσπάθεια.
  • Συντομία . Οι άνθρωποι είναι απασχολημένοι. Μια ιστορία πρέπει να είναι όσο το δυνατόν συντομότερη, αλλά όχι μικρότερη. Μπορούμε συχνά να κόβουμε λίπος χωρίς να θυσιάζουμε πολύ με τον τρόπο νοήματος. Δημοσιεύουμε πολλές μακρύτερες ιστορίες, όπως η ιστορία μου στην ιστορία του ανοιχτού διαδικτύου. Πέρασα 3 μήνες για να το ερευνήσω και αρχικά επρόκειτο να είναι ένα βιβλίο, αλλά κατάφερα να το περιορίσω στο σημείο που θα μπορούσα να το εκφράσω σε μια ανάγνωση 26 λεπτών. Ίσως υπάρχει περιθώριο να το μειώσουμε ακόμη περισσότερο.

Και πάλι, όλες αυτές οι αρετές προέρχονται από την πραγματικότητα της σύγχρονης εποχής μας: οι άνθρωποι είναι απασχολημένοι .

Εάν οι άνθρωποι δεν ήταν απασχολημένοι, μπορεί να ενδιαφέρονται περισσότερο να διαβάσουν ένα νοσταλγικό κομμάτι για το πρώτο Commodore 64 κάποιου. Μπορεί να είναι πρόθυμοι να αγωνιστούν μέσα από μερικά προπτυχιακά βιβλία κειμένου, ώστε να μπορούν να καταλάβουν την πραγματική πραγματεία κάποιου στο cloud computing. Ίσως να αφιερώσουν χρόνο για να διαβάσουν έναν μαζικό τόμο ενός άρθρου αντί για τις σημειώσεις του. Αλλά οι περισσότεροι άνθρωποι είναι πολύ απασχολημένοι για αυτό.

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

Εργαλεία για να προσελκύσετε το ενδιαφέρον των πολυάσχολων ανθρώπων

Έχουμε μόνο δύο εργαλεία ενάντια στον αδυσώπητο κύκλο ροών ειδήσεων: έναν τίτλο και μια εικόνα.

Δείτε πώς μοιάζει μια ιστορία στη ροή ειδήσεων του Medium:

Δείτε πώς φαίνεται στο Facebook:

Και εδώ φαίνεται στο Twitter:

Ο τίτλος και η αρχική εικόνα είναι τα μόνα πράγματα που πρέπει να κρίνουν οι άνθρωποι μια ιστορία. Για να μπορέσουν ακόμη να διαβάσουν την πρώτη παράγραφο της ιστορίας, πρέπει να απαντήσουν σε μια ερώτηση. Είναι το ίδιο ερώτημα που όλοι αναρωτιόμαστε κάθε μέρα: αυτό θα αξίζει τον χρόνο μου;

Η πρώτη σας δουλειά ως συντάκτης είναι να επιλέξετε έναν τίτλο και μια εικόνα που θα κάνει τους αναγνώστες - πολυάσχολους ανθρώπους να κάνουν κύλιση στο Reddit ή στις ροές ειδήσεων στο Facebook - να απαντούν "ναι".

Ένας καλός τίτλος κάνει όλη τη διαφορά

Ο τίτλος είναι το πιο σημαντικό μέρος της ιστορίας. Περάστε χρόνο για να το βελτιώσετε.

Μην χρησιμοποιήσετε το clickbait περίεργου κενού: "Δεν θα το πιστέψετε αυτό το γελοία αποτελεσματικό σκούρο μοτίβο."

Μην χρησιμοποιείτε επικεφαλίδες καταλόγων και γενικά αποφύγετε τα άρθρα που είναι δομημένα ως λίστες: «11 εξωφρενικές επικεφαλίδες που θα αναγκάσουν τους ανθρώπους να διαβάσουν τη μεσαία ιστορία σας». (Είμαι ένοχος που έγραψα ένα πλοκάριο, και παρόλο που ήταν γενικά αποδεκτό, εξακολουθώ να νιώθω ότι ήταν τεμπέλης από εμένα.)

Πείτε την αλήθεια: "Έξυπνος αλλά ουσιαστικός τίτλος για ένα ενδιαφέρον θέμα."

Πόσο καιρό πρέπει να είναι οι τίτλοι; Το HubSpot ανέλυσε 6.000 αναρτήσεις ιστολογίου και διαπίστωσε ότι οι ιστορίες με τίτλους 8 έως 14 λέξεων λαμβάνουν περισσότερες κοινοποιήσεις στα μέσα κοινωνικής δικτύωσης.

Ωστόσο, βεβαιωθείτε ότι ο τίτλος είναι 80 χαρακτήρες ή λιγότεροι . Διαφορετικά, ο τίτλος θα περικοπεί στις ροές ειδήσεων όταν οι άνθρωποι μοιράζονται μια ιστορία στο Facebook και το Twitter.

Ένα άλλο ζήτημα είναι πόσο συναισθηματικός είναι ένας τίτλος. Όσο πιο συναισθηματική (θετική ή αρνητική) είναι μια επικεφαλίδα, τόσο πιο πιθανό θα κάνουν κλικ σε αυτόν.

Οι επικεφαλίδες γράφονται παραδοσιακά σε "υπόθεση τίτλου". Το Associated Press λέει ότι «κεφαλαιοποιεί το πρώτο γράμμα κάθε λέξης εκτός από άρθρα, συντονιστικούς συνδυασμούς και προθέσεις τριών γραμμάτων ή λιγότερων».

Στο Medium, πετάω συχνά την υπόθεση του τίτλου έξω από το παράθυρο και γράφω μόνο τίτλους σαν μια κανονική πρόταση. Περιλαμβάνω ακόμη και σημεία στίξης όπως είναι απαραίτητο. Αυτή η μορφή είναι πιο συνομιλητική και πιο ευανάγνωστη.

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

Σύλληψη με εικόνες

Η δεύτερη πιο σημαντική πτυχή μιας ιστορίας είναι η επιλεγμένη εικόνα της.

Συμπεριλάβετε πάντα τουλάχιστον μία εικόνα σε μια ιστορία (κατά προτίμηση στην κορυφή). Αυτό έχει τα ακόλουθα οφέλη:

  1. Όταν οι άνθρωποι μοιράζονται την ιστορία στο Facebook και το Twitter, θα είναι πιο εμφανής στις ροές ειδήσεων, κάνοντας τους ανθρώπους πιο πιθανό να κάνουν κλικ σε αυτήν.
  2. Θα φαίνεται καλύτερα στις ροές ειδήσεων του Medium.
  3. Οι άνθρωποι είναι οπτικά πλάσματα και κάνουν κλικ σε εικόνες.

Κατά τη δημοσίευση μιας ιστορίας, το Medium σάς επιτρέπει να επιλέξετε ποια εικόνα θέλετε να είναι η επιλεγμένη εικόνα της ιστορίας. Αυτό σημαίνει ότι η ιδιότητα meta της ιστορίας og-image θα είναι αυτή η εικόνα. Αυτή η εικόνα θα χρησιμεύσει ως πρεσβευτής της ιστορίας παντού: ροές ειδήσεων στα μέσα κοινωνικής δικτύωσης, Reddit, Ειδήσεις Google - ακόμη και αναγνώστες RSS.

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

Πρέπει να χωρίσετε μεγάλες ιστορίες με εικόνες. Για να παραφράσω τη Mary Poppins, μια κουταλιά εικόνων βοηθά το κείμενο να μειωθεί.

Το Medium προσφέρει τέσσερα διαφορετικά πλάτη εικόνας. Σημειώστε ότι όλα αυτά θα φαίνονται τα ίδια στο κινητό.

Τις περισσότερες φορές, θα θέλετε να διατηρήσετε το πλάτος της στήλης:

Εάν έχετε ένα γράφημα που είναι δύσκολο να διαβαστεί όταν είναι μικρό, μεγαλώστε:

Και αν είστε πραγματικά περήφανοι για μια εικόνα ή εάν είναι γεμάτη από ενδιαφέροντα δεδομένα, πηγαίνετε πλήρως:

… Και μετά υπάρχει πλαϊνό. Μην χρησιμοποιείτε καθόλου αυτό το μέγεθος, επειδή καθιστά το κείμενο λιγότερο άνετο στην ανάγνωση.

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

Ναι. Είμαι ακόμα κολλημένος εδώ.

Εάν πρέπει να προσθέσετε μια εικόνα σε μια ιστορία, τραβήξτε μια θεματικά σχετική εικόνα με άδεια Creative Commons Zero από το pexels.com. Μπορείτε να τα χρησιμοποιήσετε δωρεάν χωρίς αναφορά.

Δημιουργήστε δυναμική με ισχυρό προβάδισμα

Μόλις ο αναγνώστης κάνει κλικ στην ιστορία, ξεκινά η δοκιμή. Ψάχνουν οποιαδήποτε δικαιολογία για να επιστρέψουν στη ροή ειδήσεων. Επειδή η ανάγνωση απαιτεί πολύ περισσότερη προσπάθεια από την κύλιση σε φωτογραφίες γάτας.

Ορισμένοι συγγραφείς χρησιμοποιούν εισαγωγές ή ενημερώσεις όπως "Αυτό δημοσιεύθηκε στο ιστολόγιό μου στο [blog URL]" ή "Ενημέρωση: αυτό δημοσιεύτηκε στο Hacker News". Εάν τα έχουν προσθέσει, θα πρέπει να τα μεταφέρετε στο κάτω μέρος της ιστορίας.

Αντ 'αυτού, το κείμενο πρέπει να αρχίσει να κάνει σημεία και να λέει μια ιστορία αμέσως.

Βοηθήστε τον συγγραφέα να αποδείξει την αξιοπιστία τους

Βρείτε έναν τρόπο να αποδείξετε την αξιοπιστία του συγγραφέα μέσα στις πρώτες παραγράφους. Εάν είναι κορυφαίος ειδικός στον τομέα σας, πείτε το. Μην υποθέσετε ότι οι χρήστες θα αφιερώσουν χρόνο για να τους κάνουν google.

"Ποιος μιλάς τόσο δυνατά, δεν μπορώ να ακούσω τι λες." - Ralph Waldo Emerson

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

Για παράδειγμα, εάν είναι πρώην μηχανικός Googler / Facebook, ή στη βασική ομάδα ενός δημοφιλούς έργου ανοιχτού κώδικα, θα πρέπει να βρείτε έναν τρόπο να το εργαστείτε φυσικά (χωρίς να ακούγεται καυχημένο). "Γιατί έφυγα από την Google για να δημιουργήσω μια προσωπική εφαρμογή χρηματοδότησης για παιδιά" ακούγεται πολύ πιο συναρπαστικό από το "Δημιουργώ μια προσωπική εφαρμογή χρηματοδότησης για να βοηθήσω τα παιδιά."

Ενισχύστε την αξιοπιστία του συγγραφέα σε όλη την ιστορία. Πρέπει να υποστηρίζουν τα επιχειρήματά τους με δεδομένα. Όπου είναι απαραίτητο, θα πρέπει να χρησιμοποιούν ενσωματωμένους συνδέσμους για έρευνα (χωρίς paywall).

Αυτό δεν είναι το New England Journal of Medicine. Αυτό είναι μεσαίο. Μην χρησιμοποιείτε λοιπόν υποσημειώσεις. Εάν ο συγγραφέας έχει χρησιμοποιήσει υποσημειώσεις, ανακαλύψτε έναν τρόπο να τις εφαρμόσετε ξανά στο κείμενο και, στη συνέχεια, αφαιρέστε τις υποσημειώσεις στο τέλος του άρθρου. Πολλές φορές, αυτές οι υποσημειώσεις δεν είναι αρκετά σημαντικές για να συμπεριληφθούν και μπορούν απλώς να διαγραφούν.

Κοίτα και στυλ

Εκτελέστε το κείμενο μέσω της εφαρμογής Hemingway. Δεν υπάρχει τίποτα μαγικό για αυτό το απλό εργαλείο, αλλά θα εντοπίσει αυτόματα ζητήματα στυλ που έχουν συμφωνηθεί ευρέως:

  • παθητική φωνή
  • περιττά επιρρήματα
  • λέξεις που έχουν πιο κοινά ισοδύναμα

Τα επίθετα μπορούν συχνά να αφαιρεθούν βρίσκοντας πιο κατάλληλα ουσιαστικά ή ρήματα.

Παρατηρώ ότι χρησιμοποιείτε απλή, απλή γλώσσα, σύντομες λέξεις και σύντομες προτάσεις. Αυτός είναι ο τρόπος για να γράψετε αγγλικά - είναι ο σύγχρονος τρόπος και ο καλύτερος τρόπος. Παρέμεινε σ 'αυτό; μην αφήσετε το χνούδι και τα λουλούδια και τη λεκτικότητα να εισέλθουν. Όταν πιάσετε ένα επίθετο, σκοτώστε το. Όχι, δεν εννοώ εντελώς, αλλά σκοτώστε τα περισσότερα - τότε τα υπόλοιπα θα είναι πολύτιμα. Αποδυναμώνουν όταν βρίσκονται κοντά. Δίνουν δύναμη όταν βρίσκονται σε απόσταση μεταξύ τους. Μια επίθετη συνήθεια, ή μια ευώδης, διάχυτη, ανθισμένη συνήθεια, μια φορά στερεωμένη σε ένα άτομο, είναι τόσο δύσκολο να απαλλαγούμε από οποιαδήποτε άλλη κακία. " - Μαρκ Τουαίην

Η εφαρμογή Hemingway θα εκχωρήσει ένα «επίπεδο βαθμού» για ένα κομμάτι γραφής. Ακόμη και οι τεχνικές ιστορίες μπορούν να ξεπεράσουν ένα επίπεδο βαθμού 6. Και πρέπει να φιλοδοξούν.

Οι περισσότεροι άνθρωποι δεν είναι εγγενείς αγγλόφωνοι και αυτοί που δεν κάθονται συνήθως διαβάζοντας το Chaucer όλη την ημέρα. Θέλουν τις πληροφορίες τους προσβάσιμες και στο σημείο.

Σφάλμα από την πλευρά της διάσπασης μακρών προτάσεων και παραγράφων σε μικρότερες.

Παρά τα όσα έχετε μάθει στην τάξη σύνθεσης στα αγγλικά, οι άνθρωποι προτιμούν τις μικρές παραγράφους από τους «τοίχους κειμένου».

Δεν υπάρχει τίποτα λάθος με παραγράφους μίας πρότασης.

Σφάλμα από τη δημιουργία νέων παραγράφων.

Χρησιμοποιήστε συσπάσεις. Θα κάνουν την πεζογραφία να φαίνεται πιο συζητητική Αυτό είναι πάντα ένα πλεονέκτημα.

Το freeCodeCamp είναι ένας μη κερδοσκοπικός οργανισμός με έδρα τις ΗΠΑ, γι 'αυτό επιλέξαμε να χρησιμοποιήσουμε αμερικανικά αγγλικά καθ' όλη τη διάρκεια της έκδοσης. Ίσως χρειαστεί να αλλάξετε την περιστασιακή "ανάλυση" σε "ανάλυση" και "χρώμα" σε "χρώμα".

Σημειώστε επίσης ότι προτιμούμε το μετρικό σύστημα από το αυτοκρατορικό σύστημα.

Ορίστε τους αριθμούς ένα έως δέκα και, στη συνέχεια, χρησιμοποιήστε τους αριθμούς 11 και άνω.

Όταν το φύλο κάποιου δεν είναι γνωστό - ή ο συγγραφέας μιλάει για ένα υποθετικό άτομο που δημιούργησαν για χάρη του σημείου - χρησιμοποιήστε πάντα «τους», «τους» και «τους». Στη σύγχρονη χρήση, αυτό λειτουργεί επίσης ως μοναδική αντωνυμία τρίτου ατόμου. Είναι απλούστερο από το να πεις «αυτός ή αυτή».

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

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

Μην χρησιμοποιείτε πτώση. Φαίνονται κομψά σε παλιά βιβλία, αλλά ανόητα στο διαδίκτυο.

Χρησιμοποιείτε μόνο ένα θαυμαστικό κάθε φορά, συνήθως μόνο μετά από θαυμαστικά όπως: Γκόλυ! Λουκάνικο!

Αναζητήστε λανθασμένα "έξυπνα εισαγωγικά" όπως αυτό: "δοκιμή" (σημειώστε ότι και τα δύο εισαγωγικά ανοίγουν εισαγωγικά.) Το Medium δεν τα λαμβάνει αυτόματα, οπότε θα πρέπει να διαγράψετε και να πληκτρολογήσετε ξανά την προσφορά, σε αυτό το σημείο Medium πρέπει να το φτιάξω.

Χρησιμοποιείτε πάντα διπλά εισαγωγικά για τις γύρω προσφορές και οτιδήποτε μπορεί να τοποθετήσει κάποιος μέσα σε «αεροπορικές προσφορές». Στη συνέχεια, χρησιμοποιήστε μεμονωμένα εισαγωγικά για εισαγωγικά εντός εισαγωγικών:

«Μερικές φορές όταν γράφω Javascript θέλω να σηκώσω τα χέρια μου και να πω« αυτός είναι ταύρος ***! » αλλά δεν μπορώ ποτέ να θυμηθώ σε τι αναφέρεται αυτό "." - Μπεν Χάλπερν

Σημειώστε ότι χρησιμοποίησα εκεί το δεύτερο στυλ απόσπασης απόσπασης του Medium, το οποίο χρησιμοποιούμε για εισαγωγικές παραγράφου.

Βάλτε κόμματα και τελείες μέσα σε εισαγωγικά, εκτός εάν μπορεί να προκαλέσει σύγχυση στον αναγνώστη (όπως με μεταβλητά ονόματα ή τίτλους βιβλίων).

Σε ορισμένα μέρη του κόσμου, οι άνθρωποι τοποθετούν κενά πριν από άνω και κάτω τελεία ή ερωτηματικά, όπως αυτό: παράδειγμα. Μην το κάνεις αυτό.

Αντί να ξεκινήσετε μια πρόταση με "Επομένως", ξεκινήστε με "Έτσι".

Αντί να ξεκινήσετε μια πρόταση με "Ωστόσο", ξεκινήστε με "Αλλά".

Χρησιμοποιήστε αγγλικά αντί για λατινικά:

  • Χρησιμοποιήστε το "για παράδειγμα" αντί για "EG"
  • Χρησιμοποιήστε το "that is" αντί για "IE"
  • Χρησιμοποιήστε το "σημειώστε ότι" αντί για "NB"
  • Αντί να τερματίζουμε λίστες με "κ.λπ." Ξεκινήστε τα με "like": "Ο Elvis τρώει φαγητό όπως ψωμί, φυστικοβούτυρο και μπανάνες."

Σύμφωνα με τα Βιβλία Google, τα ερωτηματικά πεθαίνουν με αργό θάνατο.

Ας τα βάλουμε από τη δυστυχία τους. Απλώς χρησιμοποιήστε μια τελεία και διαχωρίστε τις ρήτρες σε ξεχωριστές προτάσεις.

Το μόνο μέρος για τα ερωτηματικά σε αυτόν τον κόσμο είναι στο τέλος μιας γραμμής κώδικα.

Χρησιμοποιήστε το Oxford Comma όταν είναι δυνατόν. Κάνει τα πράγματα πιο εύκολα, πιο καθαρά και πιο όμορφα για ανάγνωση.

Σε αντίθεση με τον κωδικό, θα πρέπει πάντα να τοποθετείτε σημεία στίξης σε εισαγωγικά, όπως αυτό: τα πιο δημοφιλή μηνύματα GitHub commit είναι "αρχική δέσμευση", "ενημέρωση readme.md" και "ενημέρωση".

Επίσης, η ανάπτυξη front-end (επίθετη μορφή με παύλα) είναι όταν εργάζεστε στο front end (ουσιαστική φόρμα χωρίς παύλα). Το ίδιο ισχύει και για το πίσω μέρος, την πλήρη στοίβα και πολλούς άλλους σύνθετους όρους.

Κωδικός βιτρίνας

Όπου είναι δυνατόν, ο κώδικας πρέπει να είναι σε μορφή κειμένου και όχι σε εικόνες. Αυτό καθιστά τον κώδικα πιο προσβάσιμο στους αναγνώστες οθόνης και είναι πιο εύκολο για τους χρήστες να αντιγράψουν και να επικολλήσουν.

Το Medium έχει μια κρυφή συντόμευση που θα μετατρέψει το απλό κείμενο ως εξής:

εάν (προγραμματιστής === true) {

ακολουθήστε (this.mediumPublication);

}

… Σε ένα μορφοποιημένο μπλοκ κώδικα:

if (developer === true) {
follow(this.mediumPublication);
}

Για να το επιτύχετε αυτό, επιλέξτε το κείμενο και, στη συνέχεια, πατήστε:

  • Windows : Control + Alt + 6
  • Mac : Εντολή + Επιλογή + 6
  • Linux : Control + Alt + 6

Μπορείτε επίσης να ξεκινήσετε ένα μπλοκ κώδικα με τριπλά πίσω. Εάν πληκτρολογήσετε τρία backticks ("") σε μια νέα γραμμή, το Medium θα μεταβεί σε λειτουργία εισαγωγής κώδικα.

Για να επισημάνετε τον κώδικα ενσωματωμένο, επιλέξτε τον και, στη συνέχεια, πατήστε το πλήκτρο backtick. Με αυτόν τον τρόπο, μπορείτε να μορφοποιήσετε κείμενο ως κώδικα freeCodeCamp()ακριβώς στη μέση μιας πρότασης.

Οι συγγραφείς μπορούν ακόμη και να ενσωματώσουν εφαρμογές που μπορούν να εκτελεστούν απευθείας στο Medium. Σε περίπτωση που αυτές δεν αποδίδονται σωστά στις εφαρμογές για κινητά του Medium, θα πρέπει να συμπεριλάβουμε συνδέσμους κάτω από καθεμία από τις ενσωματώσεις ως εναλλακτικό.

Επικολλήστε ένα URL CodePen.io στο Medium και, στη συνέχεια, πατήστε enter:

Δείτε το CodePen μου εδώ.

Μπορείτε επίσης να το κάνετε αυτό με το JSFiddle.net:

Δείτε το JSFiddle εδώ.

Μερικές φορές οι άνθρωποι ξεκινούν γραμμές κώδικα με ένα $αν είναι τερματικές εντολές. Μην το κάνεις αυτό. Θα προκαλέσει σύγχυση στους αρχάριους και δυσκολεύει την αντιγραφή και επικόλληση εντολών. Αντ 'αυτού, απλώς πείτε κάτι όπως "Εισαγάγετε τις ακόλουθες εντολές στο τερματικό σας."

Κάντε τους συνδέσμους να φαίνονται φυσικοί

Βρείτε έναν τρόπο για να επεξεργαστείτε έναν σύνδεσμο σε μια πρόταση. Ένα πράγμα που δεν συνιστώ να κάνω είναι να βάζεις έναν σύνδεσμο στη δική του γραμμή και να πατάς enter. Αυτό θα δημιουργήσει μια ωραία κάρτα προεπισκόπησης, όπως αυτή:

Πώς να στέκεστε στους ώμους των γιγάντων

Κατακτήστε το σύνδρομο που δεν εφευρέθηκε εδώ και κάντε κάτι νέο. medium.freecodecamp.com

… Αλλά οι αναγνώστες συχνά υποθέτουν ότι είναι διαφημίσεις και δεν τις βλέπουν καν.

Η μόνη φορά που θα συνιστούσα να το χρησιμοποιήσετε είναι στο τέλος μιας ιστορίας, εάν θέλετε να συνδεθείτε με περαιτέρω ανάγνωση.

Η υπογράμμιση του κειμένου καθιστά δυσκολότερη την ανάγνωση, οπότε μόνο υπερσύνδεση λίγων λέξεων.

Μην επικολλάτε απευθείας διευθύνσεις URL, όπως αυτό: www. //www.freecodecamp.org ❌

Αντ 'αυτού, συνδέστε με ιστότοπους όπως το FreeCodeCamp μεσαία πρόταση, όπως το έκανα εδώ.

Ενσωμάτωση μέσων

Μπορείτε να ενσωματώσετε Tweets, βίντεο YouTube και άλλα μέσα, επικολλώντας τα URL τους στο Medium σε μια νέα γραμμή και, στη συνέχεια, πατώντας enter.

Χρησιμοποιήστε τα με φειδώ, καθώς ενδέχεται να αποσπάσουν τον αναγνώστη από το να ολοκληρώσει την ιστορία σας.

Εξηγήστε τις συντομογραφίες

Μην χρησιμοποιείτε συντομογραφία εκτός εάν η συντομογραφία είναι ευρύτερα κατανοητή από ό, τι σημαίνει. Για παράδειγμα, το HTTP είναι ευρύτερα αναγνωρισμένο από το Hypertext Transfer Protocol.

Εάν μια συντομογραφία δεν είναι ήδη ευρέως κατανοητή και πρόκειται να την αναφέρετε περισσότερες από μερικές φορές, μπορείτε να την ορίσετε ως συντομογραφία κάνοντας αυτό:

«Ας σπάσουμε τον κώδικα σε ένα Abstract Syntax Tree (AST).»

Εδώ συνδέθηκα επίσης με το άρθρο της Wikipedia, για την ευκολία των αναγνωστών. Μην υποθέτετε ότι οι άνθρωποι θα διαβάσουν αυτούς τους εξωτερικούς συνδέσμους, ωστόσο. Πρέπει ακόμη να ορίσετε έννοιες ή να τις επεξηγήσετε μέσω παραδείγματος.

Αποφύγετε να ορίσετε μια συντομογραφία στις αρχικές παραγράφους σας, καθώς επιβραδύνει τον αναγνώστη σας και τους καθιστά λιγότερο πιθανό να συνεχίσουν να διαβάζουν.

Ακολουθεί η πολύ σύντομη λίστα της συντομογραφίας τεχνολογίας που δεν χρειάζεται να ορίσετε: API, AJAX, BIOS, CPU, CSS, HTML, HTTPS, JSON, LAN, RAM, REST, USB, WWW, XML. Για οτιδήποτε άλλο, πρέπει να το εξηγήσετε.

Πάντα να γράφετε σύντομες λέξεις πολλαπλών τμημάτων, όπως JavaScript και διεπαφή. Μην τα συντομεύσετε. Η συντομία δεν αξίζει την πιθανή σύγχυση.

Προσθέστε 5 ετικέτες

Το Medium σας επιτρέπει να προσθέσετε έως και πέντε ετικέτες σε μια ιστορία. ΧΡΗΣΙΜΟΠΟΙΗΣΕ τους.

Οι χρήστες ακολουθούν συγκεκριμένα θέματα στο Medium. Τα πιο δημοφιλή είναι τα #tech, # life-سبق, #travel, #design και #startup.

Τα άτομα που ακολουθούν τις ετικέτες που χρησιμοποιείτε ενδέχεται να δουν την ιστορία στη ροή ειδήσεων. Οι ετικέτες διευκολύνουν επίσης τους ανθρώπους να σκοντάψουν την ιστορία στα αποτελέσματα αναζήτησης.

Εάν ένας συγγραφέας επέλεξε μια ετικέτα που δεν είναι πολύ δημοφιλής, μπορείτε να την αντικαταστήσετε με την πιο δημοφιλή παραλλαγή. Για παράδειγμα, το "JS" είναι μια πολύ λιγότερο δημοφιλής ετικέτα από το "JavaScript". Τα "UXD" και "UX Design" είναι πολύ λιγότερο δημοφιλή από τα "UX".

Θα πρέπει επίσης να χρησιμοποιείτε όσο το δυνατόν πιο διαφορετικές ετικέτες (υποθέτοντας ότι είναι σχετικές με το άρθρο.) Για παράδειγμα, ένα άρθρο σχετικά με την ανάπτυξη Android δεν χρειάζεται "Android", "AndroidDev" και "Εφαρμογές Android". Οι αναγνώστες που ακολουθούν το "AndroidDev" πιθανώς ακολουθούν επίσης το "Android", επομένως είναι σπατάλη πολύτιμων ακινήτων. Αντ 'αυτού, μπορείτε να προσθέσετε πιο δημοφιλείς σχετικές ετικέτες όπως "προγραμματισμός" και "τεχνολογία".

Αποδεκτά επίπεδα αυτοπροώθησης

Οι συγγραφείς γράφουν για να διαδώσουν τη γνώση, αλλά και οι περισσότεροι έχουν επιπλέον κίνητρα.

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

Όλα αυτά είναι καλά. Αλλά πρέπει να γίνουν μέσα στο λόγο και στο υποσέλιδο του άρθρου.

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

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

Το Medium άλλαξε πρόσφατα από καρδιές σε χειροκρότημα. Αλλά πολλοί συγγραφείς ζητούν ακόμα καρδιές. Γι 'αυτό φροντίστε να αλλάξετε τα αιτήματά τους για να αναφέρετε τα χειροκρότημα.

Για παράδειγμα, εδώ είναι μια γραμμή που θα μπορούσατε να χρησιμοποιήσετε: "Εάν βρήκατε αυτό το άρθρο χρήσιμο, δώστε μου χειροκρότημα;".

Πράγματα που πρέπει να προσέξετε ως συντάκτης

Λογοκλοπή

Η λογοκλοπή - όταν κάποιος παρερμηνεύει τη γραφή κάποιου άλλου ως δική του - είναι ένα σοβαρό αδίκημα στην ακαδημαϊκή κοινότητα, και είναι εξίσου σοβαρό με το Medium. Οι συγγραφείς πρέπει πάντα να αποδίδουν αποσπάσματα στα άτομα που τα είπαν αρχικά.

Εάν πρόκειται για μια προσφορά πολλαπλών γραμμών, θα πρέπει να χρησιμοποιήσετε τα εισαγωγικά pull Medium:

«Όταν έχετε το δικό σας πνεύμα, είναι ευχαρίστηση να πιστώσετε τους άλλους για τα δικά τους». - Κρίσε Τζαμί

Εάν υποψιάζεστε λογοκλοπή - για παράδειγμα, μια παράγραφος τέλειων αγγλικών σε ένα άρθρο που διαφορετικά διαβάζει αφύσικα ή κάτι που φαίνεται εξαιρετικά πνευματώδες σε ένα κατά τα άλλα ξηρό άρθρο - πάρτε την ύποπτη παράγραφο και επικολλήστε την στο Google. Αυτή είναι μια βολική πρώτη γραμμή άμυνας.

Εάν ένα απόσπασμα φαίνεται να είναι λογοκλοπή, σταματήστε την επεξεργασία. Δεν θα το δημοσιεύσουμε. Στείλτε μου ένα email για να με ενημερώσετε. Θα χειριστώ το δυσάρεστο έργο να δώσω στον συγγραφέα κάποια «πραγματική συζήτηση» για εσάς.

Φύλαξη πυλών

"Το Gatekeeping είναι όταν κάποιος αναλαμβάνει τον εαυτό του να αποφασίσει ποιος έχει ή δεν έχει πρόσβαση ή δικαιώματα σε μια κοινότητα ή ταυτότητα." - Αστικό λεξικό

Το Gatekeeping είναι μια μορφή ελιτισμού και έρχεται σε αντίθεση με την αρχή της προσβασιμότητας. Αν θέλετε να κατανοήσετε καλύτερα τι είναι η πύλη, το Reddit διαθέτει ένα subreddit αφιερωμένο σε αυτό με μερικά θλιβερά (και περιστασιακά, ειρωνικά) παραδείγματα.

Πολλές φορές, οι συγγραφείς δεν συνειδητοποιούν ότι φυλάσσονται. Ακολουθούν ορισμένες εκφράσεις που μπορεί να χρησιμοποιούν:

  • προφανώς
  • απλά [κάνε κάτι]
  • φυσικά [κάτι είναι κάτι τέτοιο]
  • όπως όλοι γνωρίζουν
  • όπως πιθανώς έχετε ακούσει
  • [κάτι] είναι εύκολο
  • οποιοδήποτε [«ηλίθιος», «ανόητος», «newbie», «script kiddie» κ.λπ.] μπορεί να [κάνει κάτι]

Εάν δείτε την φύλαξη, απλά αφαιρέστε την Οι περισσότερες από αυτές τις εκφράσεις δεν προσθέτουν πραγματικά τίποτα στο άρθρο.

Διάκριση

Έχουμε έναν αυστηρό κώδικα συμπεριφοράς που επιδιώκει να αποτρέψει τα άτομα από διακρίσεις βάσει «φύλου, ταυτότητας φύλου και έκφρασης, ηλικίας, σεξουαλικού προσανατολισμού, αναπηρίας, φυσικής εμφάνισης, μεγέθους σώματος, φυλής, εθνικής καταγωγής ή θρησκείας (ή έλλειψη αυτού). "

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

Περιττή βλασφημία

Διαβάζουμε ευρέως κοινό από όλες τις ηλικίες, επομένως προσπαθούμε να μην δημοσιεύσουμε καθόλου βωμολοχίες.

Ήπιες λέξεις βωμολοχίες όπως «βλασφημίες» και εκφράσεις όπως «τι διάολο» είναι αποδεκτές.

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

Μερικές φορές η λέξη f περιλαμβάνεται ως επίθετο, για παράδειγμα, το οποίο είναι βασικά περιττό. Οι άνθρωποι χρησιμοποιούν συχνά τη λέξη s ως συνώνυμο του «κακού», και αυτό μπορεί επίσης να αντικατασταθεί με κάτι λιγότερο βωμολοχίες. Η έκφραση "BS" σημαίνει βασικά "αναληθές" ή "ψέματα".

Είμαστε μια τεχνική έκδοση, οπότε στις περισσότερες περιπτώσεις η γραφή δεν θα είναι πολύ θερμή. Σε περίπτωση αμφιβολίας, μπορείτε να χρησιμοποιήσετε το **** για να αντικαταστήσετε μέρος της προσβλητικής λέξης.

Διαδικασία μετά τη δημοσίευση

Αφού δημοσιεύσουμε ένα άρθρο, το βοηθάμε να το δημοσιεύσουμε στο Twitter, το Facebook και το LinkedIn. Χρησιμοποιούμε το Buffer για να προγραμματίσουμε όλες αυτές τις δημοσιεύσεις, έτσι ώστε να βγαίνουν στις καλύτερες δυνατές στιγμές.

Πριν από τη δημοσίευση, εκτελούμε τα άρθρα μέσω του προγράμματος εντοπισμού σφαλμάτων Facebook και του επικυρωτή καρτών του Twitter. Εάν φαίνονται καλά και έτοιμα να ξεκινήσουν, χτυπάμε το εικονίδιο «tweet» στο δημοσιευμένο άρθρο Medium, αντιγράφουμε το κείμενο του tweet και φορτώνουμε αυτό το κείμενο στο Buffer.

Για αναρτήσεις στο Twitter, απλώς καταργούμε τα εισαγωγικά γύρω από τον τίτλο του άρθρου και προσθέτουμε ένα κόμμα μετά τον τίτλο (εάν δεν υπάρχει άλλη στίξη στο τέλος). Εάν το Medium καλέσει τον συγγραφέα από τη λαβή του στο Twitter, αφήνουμε το "by @username" εκεί. Εάν χρησιμοποιεί απλώς το πλήρες όνομά τους, διαγράφουμε το τμήμα «από [όνομα] [επώνυμο]» από το tweet.

Για τις αναρτήσεις LinkedIn και Facebook, καταργούμε τα αποσπάσματα από τον τίτλο και διαγράφουμε το υπόλοιπο κείμενο, αφήνοντας μόνο τον τίτλο της ανάρτησης και τον σύνδεσμο.

Μόλις αποθηκεύσουμε αυτές τις αναρτήσεις, θεωρούμε ότι το άρθρο έχει ολοκληρωθεί.

συμπέρασμα

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

Αυτό είναι ένα παράδειγμα υποσέλιδου για ένα άρθρο Medium.

Ευχαριστώ για την ανάγνωση. Εάν έχετε σκέψεις για αυτό, φροντίστε να αφήσετε ένα σχόλιο.

Εάν βρήκατε αυτό το άρθρο χρήσιμο, δώστε μου κάποια χειροκροτήματα;

Και μπορείτε να με ακολουθήσετε στο Twitter εδώ.