Πώς να σπάσετε τη Διαδικασία Εφαρμογής Google Season of Docs για το 2020

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

Στο εναρκτήριο πρόγραμμα Google Season of Docs (GSoD) το 2019, το πρόγραμμα έλαβε σχεδόν 450 αιτήσεις τεχνικών συγγραφέων και πάνω από 50 τεχνικοί συγγραφείς έγιναν δεκτές.

Ως ένας από τους τεχνικούς συγγραφείς που έγιναν δεκτοί να συμμετάσχουν στο πρόγραμμα Google Season of Docs, σκέφτηκα να μοιραστώ μερικές πληροφορίες σχετικά με τον τρόπο προετοιμασίας και δημιουργίας μιας ισχυρής εφαρμογής για το πρόγραμμα GSoD.

Πίνακας περιεχομένων

  • Τι είναι το Google Season of Docs;
  • Ποιος δικαιούται να συμμετάσχει στο πρόγραμμα;
  • Οφέλη από τη συμμετοχή
  • 5 Συμβουλές για την εφαρμογή GSoD
  • Η εμπειρία μου στο GSoD
  • Χρήσιμοι πόροι

Τι είναι το Google Season of Docs;

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

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

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

Ποιος δικαιούται να συμμετάσχει στο πρόγραμμα;

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

Εάν πληροίτε αυτά τα προσόντα, μπορείτε να υποβάλετε αίτηση για συμμετοχή στο πρόγραμμα Google Season of Docs.

Οφέλη από τη συμμετοχή

Υπάρχουν τόσα πολλά οφέλη με τη συμμετοχή στο πρόγραμμα Season of Docs. Μερικοι ειναι:

Μπορείτε να πάρετε ένα επίδομα

Αφού ολοκληρώσετε το πρόγραμμα Google Season of Docs, πληρώνετε ένα επίδομα από την Google. Είναι σημαντικό να σημειωθεί ότι αυτό το επίδομα είναι προαιρετικό, οπότε πρέπει να δηλώσετε ότι θέλετε να πληρωθείτε κατά τη φάση της αίτησης.

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

Βελτιώνετε τις δεξιότητές σας

Ένα άλλο προφανές πλεονέκτημα της συμμετοχής στο πρόγραμμα Google Season of Docs είναι ότι σας επιτρέπει να βελτιώσετε τις δεξιότητές σας ως τεχνικός συγγραφέας.

Επεκτείνετε το δίκτυό σας

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

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

Μπορείτε να λάβετε προτάσεις και παραπομπές

Κατά την υποβολή αίτησης για οποιαδήποτε εργασία, η καλή επιστολή σύστασης συχνά βοηθά στην ενίσχυση της αίτησής σας.

Η στενή συνεργασία με έναν μέντορα για το έργο Season of Docs προσφέρει την ευκαιρία να εξασφαλίσετε μια πλούσια πηγή προτάσεων και παραπομπών.

Αποκτάτε πρόσβαση σε μελλοντικές ευκαιρίες

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

Γίνετε συνεισφέρων ανοιχτού κώδικα

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

5 Συμβουλές για την εφαρμογή GSoD

Ακολουθούν 5 συμβουλές για να σας βοηθήσουν να προετοιμάσετε και να δημιουργήσετε μια ισχυρή εφαρμογή για το πρόγραμμα Season of Docs.

Δημιουργήστε και δημοσιεύστε άρθρα στο ιστολόγιό σας

Ένα από τα πιο σημαντικά κριτήρια για να γίνεις δεκτός ως τεχνικός συγγραφέας στο πρόγραμμα Google Season of Docs είναι η δυνατότητα να δείξεις ότι έχεις προηγούμενη εμπειρία γραφής.

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

Ευτυχώς, δεν είναι πολύ αργά για να δημιουργήσετε ένα blog ή να δημοσιεύσετε περισσότερο περιεχόμενο στο ήδη υπάρχον ιστολόγιό σας.

Εάν έχετε ήδη ένα blog, είναι καλή ιδέα να δημοσιεύσετε περισσότερα καλογραμμένα άρθρα πριν, κατά τη διάρκεια και αφού υποβάλετε την πρότασή σας. Εάν δεν έχετε κανένα ιστολόγιο, εξακολουθεί να μην είναι πολύ αργά για να δημιουργήσετε ένα χρησιμοποιώντας το Hashnode's Devblog ή την πλατφόρμα που προτιμάτε και να δημοσιεύσετε καλά γραπτά άρθρα.

Επιλέξτε το σωστό έργο ανοιχτού κώδικα

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

Εδώ είναι οι σκέψεις μου για την επιλογή του σωστού έργου:

  • Εξετάστε όλα τα εγκεκριμένα έργα και προσπαθήστε να επιλέξετε τουλάχιστον 5 έργα που σας ενδιαφέρουν.
  • Αφού επιλέξετε τουλάχιστον 5 έργα, σαρώστε ξανά και μειώστε τα έργα σε 3 έργα κατ 'ανώτατο όριο και τουλάχιστον 2 έργα.
  • Παρόλο που μπορεί να είναι λογικό να εστιάσετε σε ένα έργο κατά τη φάση της αίτησης, σας προτείνω να υποβάλετε αίτηση για τουλάχιστον δύο έργα για να βελτιώσετε τις πιθανότητές σας να γίνετε αποδεκτοί για τουλάχιστον ένα έργο.
  • Για κάθε έργο που επιλέγετε, εγγραφείτε στο κανάλι επικοινωνίας των οργανισμών και ενημερώστε τους συντηρητές του έργου για το ενδιαφέρον σας για αυτό το έργο. Με αυτόν τον τρόπο, θα είστε σε θέση να δημιουργήσετε μια σχέση μεταξύ εσάς και του μέντορα. Επίσης, σημειώστε ότι οι μέντορες δεν επιλέγουν ανθρώπους μόνο και μόνο επειδή έχουν τις απαραίτητες δεξιότητες. Επιλέγουν επίσης αιτούντες επειδή πιστεύουν ότι μπορούν να συνεργαστούν και μαζί τους. Έτσι, όταν στέλνετε ένα μήνυμα σε έναν μέντορα, να είστε σαφείς για το τι ακριβώς χρειάζεστε και το πιο σημαντικό να μην αναστατωθείτε ότι δεν ανταποκρίθηκαν αμέσως, επειδή οι περισσότεροι από τους μέντορες είναι εθελοντές που έχουν άλλες θέσεις εργασίας πλήρους απασχόλησης.
  • Μην περιμένετε να ταΐσετε με κουτάλι. Εκτελέστε πολλή έρευνα σχετικά με το έργο. Ανακαλύψτε και κατανοήστε όλα όσα πρέπει να γνωρίζετε και εάν έχετε οποιεσδήποτε ανησυχίες, επικοινωνήστε με τον προτεινόμενο μέντορα αυτού του έργου για βοήθεια ή ζητήστε από άλλα μέλη αυτής της κοινότητας.
  • Το πιο σημαντικό, γράψτε ό, τι ανακαλύπτετε κατά τη διάρκεια της έρευνάς σας που θα είναι χρήσιμο εάν αποδεχτείτε να εργαστείτε στο έργο ή πληροφορίες που θα βοηθήσουν στη βελτίωση της πρότασής σας.

Γράψτε μια πρόταση

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

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

Αφού γράψετε την πρότασή σας, στείλτε την στον μέντορα του έργου για έλεγχο. Η κριτική τους θα σας βοηθήσει να γνωρίζετε τις απαιτήσεις του έργου από την άποψη του μέντορα. Έχω προσθέσει έναν σύνδεσμο για την πρόταση Google Season of Docs στην ενότητα Πόροι.

Κάντε τουλάχιστον μία συνεισφορά στον Οργανισμό Ανοιχτού Κώδικα

Το πρόγραμμα Season of Docs δεν μοιάζει με το Google Summer of Code όπου απαιτείται από εσάς να κάνετε τουλάχιστον μία συνεισφορά στο έργο ανοιχτού κώδικα που σας ενδιαφέρει. Αλλά η συνεισφορά μπορεί σίγουρα να βελτιώσει την πιθανότητά σας να γίνετε αποδεκτοί, οπότε προσπαθήστε να το κάνετε.

Παραμείνετε ενεργοί στην κοινότητα μετά την προθεσμία υποβολής αιτήσεων

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

Η εμπειρία μου στο GSoD

Κατά τη διάρκεια του προγράμματος GSoD πέρυσι, ήμουν κατάλληλος να συνεργαστώ με τον οργανισμό VideoLAN στο έργο Modernize (rewrite) της τεκμηρίωσης χρήστη VLC.

Μετά την αποδοχή της πρότασής μου από τον οργανισμό VideoLAN, οι μέντορά μου και εγώ συμφωνήσαμε για τους στόχους που αναμενόταν να πετύχω κατά τη διάρκεια του προγράμματος Google Season of Docs.

Αυτοί ήταν οι στόχοι μου:

  1. Αναδιάρθρωση της τεκμηρίωσης.
  2. Ενημερώστε την τεκμηρίωση για να ταιριάζει στις σύγχρονες εκδόσεις του VLC.
  3. Μετεγκαταστήστε την τεκμηρίωση χρήστη στο Gitlab χρησιμοποιώντας Sphinx και ReadtheDocs.
  4. Καταργήστε παρωχημένες εικόνες και πληροφορίες.
  5. Ξαναγράψτε την τεκμηρίωση χρήστη για να την καταλάβετε εύκολα.
  6. Ρυθμίστε το για μετάφραση χρησιμοποιώντας το Sphinx Internationalization.

Έμαθα πολλά περισσότερα για τον οργανισμό VideoLAN και το VLC, ανακάλυψα ότι το VLC έχει περισσότερες δυνατότητες που δεν ήξερα ποτέ και έμαθα πώς να χρησιμοποιώ την πλατφόρμα τεκμηρίωσης Sphinx και να αναδιαρθρώσω το κείμενο.

Οι τεχνικές μου δεξιότητες επίσης βελτιώθηκαν. Συνολικά, η συμμετοχή στο πρόγραμμα Google Season of Docs ήταν ένα από τα καλύτερα πράγματα που μου συνέβη το 2019.

Χρήσιμοι πόροι

Βρείτε παρακάτω μια λίστα χρήσιμων πόρων που θα σας βοηθήσουν να μάθετε περισσότερα σχετικά με το πρόγραμμα Season of Docs και το Technical Writing.

  • Η πρόταση της Αποδεκτής περιόδου των Εγγράφων μου
  • Αναφορά έργου Google Season of Docs
  • Συνεισφορές ανοιχτού κώδικα: Ένας καταλύτης για την ανάπτυξη
  • Οδηγός τεχνικού συγγραφέα
  • Σεζόν του καναλιού Slack των Εγγράφων
  • Φοβερό τεχνικό γράψιμο

Σας αρέσει αυτό το άρθρο; Ακολουθήστε @Didicodes στο Twitter.