De-a lungul anilor, sondaje au arătat importanța unei bune documentații în modul în care dezvoltatorii aleg și folosesc open source.

În programul inaugural Google Season of Docs (GSoD) din 2019, programul a primit aproape 450 de cereri de redactare tehnică și peste 50 de redactori tehnici au fost acceptate.

Fiind unul dintre scriitorii tehnici care au fost acceptați să participe la programul Google Season of Docs, m-am gândit să împărtășesc câteva informații despre cum să pregătiți și să creați o aplicație puternică pentru programul GSoD.

Cuprins

  • Ce este Sezonul Google Docs?
  • Cine este eligibil să participe la program?
  • Avantajele participării
  • 5 sfaturi pentru a vă aplica aplicația GSoD
  • Experiența mea GSoD
  • Resurse utile

Ce este Sezonul Google Docs?

Season of Docs este un program anual organizat de Google. Scopul său este de a aduce scriitori tehnici și organizații open source împreună pentru a încuraja colaborarea și îmbunătățirea documentației în spațiul Open Source.

Această inițiativă este extrem de importantă, deoarece documentația unui proiect Open Source oferă utilizatorilor o cale de a înțelege nu numai proiectul, ci și de a contribui la acesta.

În timpul programului, scriitorii tehnici acceptați petrec între 3-5 luni fie construind un nou set de documente, îmbunătățind structura documentelor existente, dezvoltând un tutorial atât de necesar, fie îmbunătățind procesele de contribuție și ghidurile unei organizații Open Source.

Cine este eligibil să participe la program?

Conform Regulile Google, trebuie să aveți cel puțin 18 ani în momentul înregistrării. De asemenea, trebuie să aveți experiență anterioară ca scriitor tehnic și să fiți eligibil să lucrați în țara dvs. de reședință.

Dacă îndepliniți aceste calificări, puteți aplica pentru a participa la programul Google Season of Docs.

Avantajele participării

Există atât de multe avantaje care vin odată cu participarea la programul Sezonul documentelor. Unii sunt:

Puteți obține o bursă

După ce ați finalizat programul Google Season of Docs, veți fi plătit de Google. Este important să rețineți că această bursă este opțională, deci trebuie să indicați că doriți să fiți plătit în timpul fazei de aplicare.

Valoarea bursei se calculează în funcție de locația dvs. Vedea aici pentru detalii complete despre indemnizații.

Îți îmbunătățești abilitățile

Un alt avantaj evident al participării la programul Google Season of Docs este că vă permite să vă îmbunătățiți abilitățile de scriitor tehnic.

Vă extindeți rețeaua

În afară de îmbunătățirea ca scriitor tehnic, aveți și ocazia de a lucra cu oameni care fac lucruri uimitoare în spațiul open source.

În cazul meu, am avut ocazia să lucrez cu Organizație VideoLAN și asta a însemnat că a trebuit să lucrez îndeaproape cu președintele organizației și cu principalii contribuitori la proiecte.

Puteți primi recomandări și recomandări

Când aplicați pentru orice loc de muncă, a avea o scrisoare de recomandare bună adesea vă ajută să vă consolidați cererea.

Colaborarea îndeaproape cu un mentor la proiectul Sezonul Docs reprezintă o oportunitate de a asigura o sursă bogată de recomandări și recomandări.

Obțineți acces la oportunități viitoare

Dacă sunteți gata să aplicați pentru un rol de scriere tehnică la Google, inclusiv experiența Sezonul documentelor în CV vă oferă mai multe avantaje în comparație cu alți solicitanți.

Devii un colaborator Open Source

În afară de toate beneficiile menționate anterior, participarea la sezonul programului Docs înseamnă că puteți contribui la proiectele Open Source. Acest lucru ajută lumea să dezvăluie stereotipul conform căruia Contribuțiile Open Source sunt destinate numai dezvoltatorilor de software.

5 sfaturi pentru a vă aplica aplicația GSoD

Iată 5 sfaturi pentru a vă ajuta să pregătiți și să creați o aplicație puternică pentru programul Sezonul Documente.

Creați și publicați articole pe blogul dvs.

Unul dintre cele mai importante criterii pentru a fi acceptat ca scriitor tehnic în programul Google Season of Docs este abilitatea de a arăta că aveți experiență scrisă anterior.

Google și mentorii propuși ai proiectului la care doriți să lucrați trebuie să fie convinși că sunteți persoana potrivită pentru a lucra la proiect. Aceasta înseamnă că vor să vadă un număr mare de documentație și articole bine scrise pe care le-ați creat.

Din fericire, nu este prea târziu să creați un blog sau să publicați mai mult conținut pe blogul dvs. deja existent.

Dacă aveți deja un blog, este o idee bună să publicați mai multe articole bine scrise înainte, în timpul și după ce ați trimis propunerea. Dacă nu aveți niciun blog, încă nu este prea târziu să creați unul folosind Devblog-ul lui Hashnode sau platforma dvs. preferată și publicați și articole bine scrise.

Alegeți proiectul Open Source potrivit

Sincer, nu pot accentua prea mult importanța alegerii proiectului Open Source potrivit. Acest lucru se datorează faptului că are un rol puternic de jucat în a vă ajuta să intrați în program.

Iată gândurile mele despre alegerea proiectului potrivit:

  • Treceți prin toate proiecte aprobate și încercați să selectați cel puțin 5 proiecte care vă interesează.
  • După selectarea a cel puțin 5 proiecte, scanați din nou și reduceți proiectele la maximum 3 proiecte și minimum 2 proiecte.
  • Deși poate fi rezonabil să vă concentrați asupra unui proiect în timpul fazei de aplicare, vă încurajez să aplicați pentru cel puțin două proiecte pentru a vă îmbunătăți șansele de a fi acceptat pentru cel puțin un proiect.
  • Pentru fiecare proiect pe care îl alegeți, alăturați-vă canalului de comunicare al organizațiilor și informați întreținătorii proiectului despre interesul dvs. pentru acel proiect. În acest fel, veți putea stabili o relație între dumneavoastră și mentor. De asemenea, rețineți că mentorii nu aleg oamenii doar pentru că au abilitățile necesare. De asemenea, selectează solicitanții deoarece cred că pot lucra și cu ei. Deci, atunci când trimiteți un mesaj unui mentor, fiți explicit cu privire la exact ce aveți nevoie și, cel mai important, nu vă supărați că nu au răspuns imediat, deoarece majoritatea mentorilor sunt voluntari care au alte locuri de muncă cu normă întreagă.
  • Nu așteptați să vă hrăniți cu lingura. Efectuați o mulțime de cercetări despre proiect. Descoperiți și înțelegeți tot ce trebuie să știți și, dacă aveți nelămuriri, contactați mentorul propus pentru acel proiect pentru ajutor sau cereți altor membri ai acelei comunități.
  • Cel mai important, scrieți orice descoperiți în timpul cercetării dvs. care vă va fi de ajutor dacă sunteți acceptat să lucrați la proiect sau informații care vă vor ajuta să vă îmbunătățiți propunerea.

Scrie o propunere

Mulți oameni nu știu acest lucru, dar scrierea unei propuneri este vitală. Vă oferă o înțelegere clară a obiectivului proiectului, a calendarului pe care îl va lua pentru a finaliza proiectul, a ceea ce trebuie să știți și așa mai departe.

În afară de aceasta, scrierea unei propuneri arată, de asemenea, mentorului dvs. obiectivele pentru proiect, de ce credeți că sunteți persoana potrivită pentru rol, experiența dvs., calendarul proiectului și multe altele.

După ce ați scris propunerea, trimiteți-o mentorului proiectului pentru examinare. Revizuirea lor vă va ajuta să cunoașteți cerințele proiectului din punctul de vedere al mentorului. Am adăugat un link către propunerea mea Google Season of Docs în secțiunea Resurse.

Faceți cel puțin o contribuție la organizația Open Source

Programul Season of Docs nu este ca Google Summer of Code, unde vi se cere să aduceți cel puțin o contribuție la proiectul de interes Open Source. Dar a contribui vă poate îmbunătăți cu siguranță șansa de a fi acceptat, așa că încercați să faceți acest lucru.

Rămâneți activ în comunitate după termenul limită de înscriere

După trimiterea cererii, încercați să rămâneți activ în acea organizație Open Source. Acest lucru arată mentorilor că sunteți pasionați de acel proiect și că comunitatea Open Source în general.

Experiența mea GSoD

În timpul programului GSoD de anul trecut, am fost oportun să lucrez cu Organizație VideoLAN pe proiect Modernizați (rescrieți) documentația utilizatorului VLC.

După ce propunerea mea a fost acceptată de organizația VideoLAN, mentorii mei și cu mine am fost de acord asupra obiectivelor pe care era de așteptat să le ating în timpul programului Google Season of Docs.

Acestea au fost obiectivele mele:

  1. Restructurați documentația.
  2. Actualizați documentația pentru a se potrivi versiunilor moderne ale VLC.
  3. Migrați documentația utilizatorului în Gitlab folosind Sphinx și ReadtheDocs.
  4. Eliminați imaginile și informațiile învechite.
  5. Rescrieți documentația utilizatorului pentru a fi ușor de înțeles.
  6. Configurați-l pentru traducere folosind Sphinx Internationalization.

Am aflat mult mai multe despre organizația VideoLAN și VLCAm aflat că VLC are mai multe caracteristici despre care nu știam niciodată și am învățat cum să folosesc platforma de documentare Sphinx și să restructurez textul.

De asemenea, abilitățile mele de scriere tehnică s-au îmbunătățit enorm. În general, participarea la programul Google Season of Docs a fost unul dintre cele mai bune lucruri care mi s-au întâmplat în 2019.

Resurse utile

Găsiți mai jos o listă de resurse utile pentru a vă ajuta să aflați mai multe despre programul Sezonul documentelor și despre scrierea tehnică.

Îți place acest articol? Urma @Didicodes pe Twitter.