Kuidas murda Google'i dokumentide hooaja 2020. aasta taotlusprotsessi

Aastate jooksul on uuringud näidanud hea dokumentatsiooni olulisust selles, kuidas arendajad avatud lähtekoodiga valivad ja kasutavad.

Google'i dokumentide hooaja (GSoD) sissejuhatavas programmis sai 2019. aastal ligi 450 tehnilise kirjutaja rakendust ja üle 50 tehnilise kirjutaja võeti vastu.

Ühe tehnilise kirjutajana, kes lubati osalema programmis Google Season of Docs, mõtlesin jagada mõningaid teadmisi selle kohta, kuidas GSoD-programmi jaoks tugevat rakendust ette valmistada ja luua.

Sisukord

  • Mis on Google'i dokumentide hooaeg?
  • Kellel on õigus programmis osaleda?
  • Osalemise eelised
  • 5 nõuannet GSoD-rakenduse ässamiseks
  • Minu GSoD kogemus
  • Kasulikud ressursid

Mis on Google'i dokumentide hooaeg?

Dokumentide hooaeg on Google'i korraldatav aastaprogramm. Selle eesmärk on viia kokku tehnilised kirjutajad ja avatud lähtekoodiga organisatsioonid, et edendada avatud lähtekoodiga ruumis koostööd ja dokumentatsiooni täiustamist.

See algatus on äärmiselt oluline, sest avatud lähtekoodiga projekti dokumentatsioon annab kasutajatele võimaluse projekti mitte ainult mõista, vaid ka sellesse panustada.

Programmi ajal kulutavad tunnustatud tehnilised kirjutajad 3–5 kuud kas uue dokumendikomplekti ehitamiseks, olemasolevate dokumentide struktuuri täiustamiseks, hädavajaliku õpetuse väljatöötamiseks või avatud lähtekoodiga organisatsiooni kaastööprotsesside ja juhendite parandamiseks.

Kellel on õigus programmis osaleda?

Google'i reeglite kohaselt peate registreerumisel olema vähemalt 18-aastane. Teil peab olema ka eelnev tehnilise kirjutaja kogemus ja õigus töötada oma elukohariigis.

Kui vastate neile kvalifikatsioonidele, saate kandideerida Google'i dokumentide hooajas osalemiseks.

Osalemise eelised

Programmi Season of Docs osalemisega kaasnevad nii palju eeliseid. Mõned on:

Saad stipendiumi

Kui olete Google'i dokumentide hooaja lõpetanud, makstakse teile Google'i stipendiumi. Oluline on märkida, et see stipendium on valikuline, nii et peate märkima, et soovite, et teile makstakse taotluse esitamise ajal.

Stipendiumi summa arvutatakse teie asukoha põhjal. Siit leiate lisateavet stipendiumide kohta.

Parandad oma oskusi

Veel üks ilmselge eelis programmis Google Season of Docs osalemisest on see, et see võimaldab teil oma tehnilise kirjutaja oskusi täiendada.

Laiendate oma võrku

Peale tehnilise kirjutajana töötamise saate ka võimaluse töötada inimestega, kes teevad avatud lähtekoodiga ruumis hämmastavaid asju.

Minu puhul sain võimaluse töötada koos VideoLAN organisatsiooniga ja see tähendas, et pidin tegema tihedat koostööd organisatsiooni presidendi ja projektide peamiste kaasaaitajatega.

Võite saada soovitusi ja suuniseid

Mis tahes tööle kandideerimisel aitab hea soovituskiri omada kandideerimist.

Tihe koostöö dokumentide hooaja mentoriga annab võimaluse kindlustada rikkalik soovituste ja suuniste allikas.

Saate juurdepääsu tulevastele võimalustele

Kui olete valmis kandideerima Google'isse tehnilise kirjutamise rolli saamiseks, annab see teie kokkuvõttesse ka oma dokumentide hooaja kogemuse, mis annab teile teiste taotlejatega võrreldes rohkem eeliseid.

Sinust saab avatud lähtekoodiga kaastöötaja

Kõigi eelnimetatud hüvede kõrval tähendab see, et osalemine Docs-programmi hooajal tähendab, et saate panustada avatud lähtekoodiga projektidesse. See aitab maailmas ümber lükata stereotüübi, et avatud lähtekoodiga kaastööd on mõeldud ainult tarkvaraarendajatele.

5 nõuannet GSoD-rakenduse ässamiseks

Siin on 5 nõuannet, mis aitavad teil ette valmistada ja luua programmi Season of Docs tugeva rakenduse.

Looge ja avaldage artikleid oma ajaveebis

Üks olulisemaid kriteeriume, kuidas Google Season of Docsis tehnilise kirjutajana aktsepteeritakse, on võime näidata, et teil on varasem kirjutamiskogemus.

Google ja projekti mentorid, kellega soovite töötada, peavad olema veendunud, et olete õige inimene projektiga tegelema. See tähendab, et nad tahavad näha head hulka hästi kirjutatud dokumente ja teie loodud artikleid.

Õnneks pole veel hilja blogi luua või oma juba olemasolevas ajaveebis rohkem sisu avaldada.

Kui teil on juba ajaveeb, on mõistlik enne ettepaneku esitamist, selle ajal ja pärast seda avaldada rohkem hästi kirjutatud artikleid. Kui teil pole ühtegi ajaveebi, pole ikkagi liiga hilja seda Hashnode'i Devblogi või teie eelistatud platvormi abil luua ja ka hästi kirjutatud artikleid avaldada.

Valige õige avatud lähtekoodiga projekt

Ausalt öeldes ei saa ma üle tähtsustada õige avatud lähtekoodiga projekti valimise olulisust. Selle põhjuseks on see, et programmis osalemisel on sellel suur roll.

Siin on minu mõtted õige projekti valimiseks:

  • Vaadake läbi kõik heakskiidetud projektid ja proovige valida vähemalt 5 teid huvitavat projekti.
  • Pärast vähemalt 5 projekti valimist skannige uuesti ja vähendage projektide arvu maksimaalselt 3 ja vähemalt 2 projekti.
  • Kuigi kandideerimise etapis võib olla mõistlik keskenduda ühele projektile, soovitan teil kandideerida vähemalt kahele projektile, et parandada oma võimalusi saada vähemalt ühte projekti.
  • Liituge iga valitud projekti puhul organisatsiooni suhtluskanaliga ja andke projekti hooldajatele teada oma huvist selle projekti vastu. Nii saate luua suhte enda ja mentori vahel. Pange tähele ka seda, et mentorid ei vali inimesi ainult seetõttu, et neil on vajalikud oskused. Samuti valivad nad taotlejad, kuna usuvad, et saavad ka nendega koostööd teha. Nii et kui saadate mentorile sõnumi, rääkige täpselt, mida vajate, ja mis kõige tähtsam, ärge pahandage, et nad ei reageerinud kohe, sest enamik mentoritest on vabatahtlikud, kellel on muid täiskohaga töökohti.
  • Ärge oodake lusikaga toitmist. Tehke projekti kohta palju uuringuid. Avastage ja mõistke kõike, mida peate teadma, ja kui teil on mingeid probleeme, pöörduge abi saamiseks projekti kavandatava mentori poole või paluge selle kogukonna teistelt liikmetelt.
  • Mis kõige tähtsam, kirjutage üles kõik, mida avastate oma uurimistöö käigus ja millest on abi, kui teid projekti heaks kiidetakse, või teavet, mis aitab teie ettepanekut paremaks muuta.

Kirjutage ettepanek

Paljud inimesed ei tea seda, kuid ettepaneku kirjutamine on ülioluline. See annab teile selge ülevaate projekti eesmärgist, ajaskaalast, mis kulub projekti lõpuleviimiseks, mida peate teadma jne.

Peale selle näitab ettepaneku kirjutamine ka mentorile teie projekti eesmärke, miks te arvate, et olete selle rolli jaoks õige inimene, oma kogemusi, projekti ajakavasid ja palju muud.

Pärast oma ettepaneku kirjutamist saatke see projekti mentorile ülevaatamiseks. Nende ülevaade aitab teil projekti nõudeid mentori vaatenurgast teada saada. Lisasin ressursside jaotisse lingi oma Google'i dokumentide hooaja ettepanekule.

Tehke vähemalt üks panus avatud lähtekoodiga organisatsiooni

Programmi Dokumentide hooaeg ei ole nagu Google Summer of Code, kus peate tegema vähemalt ühe panuse huvipakkuvasse avatud lähtekoodiga projekti. Kuid panuse andmine võib kindlasti teie võimalust saada heaks kiidetud, nii et proovige seda teha.

Pärast taotluste esitamise tähtaega olge kogukonnas aktiivne

Pärast taotluse esitamist proovige selles avatud lähtekoodiga organisatsioonis aktiivne olla. See näitab mentoritele, et olete selle projekti ja kogu avatud lähtekoodiga kogukonna vastu kirglik.

Minu GSoD kogemus

Eelmise aasta GSoD programmi ajal oli mul sobiv töötada koos VideoLAN organisatsiooniga projektiga VLC kasutaja dokumentatsiooni ajakohastamine (ümberkirjutamine).

Pärast seda, kui organisatsioon VideoLAN oli minu ettepaneku vastu võtnud, leppisime mentoritega kokku eesmärkides, mille ma eeldatavasti saavutasin Google'i dokumentide hooajal.

Need olid minu eesmärgid:

  1. Ümber korraldada dokumentatsioon.
  2. Värskendage dokumentatsiooni, et see sobiks VLC kaasaegsete versioonidega.
  3. Migreerige kasutaja dokumentatsioon rakendusse Spitx ja ReadtheDocs, kasutades rakendust Gitlab.
  4. Vananenud piltide ja teabe eemaldamine.
  5. Kirjuta hõlpsasti arusaadavaks kasutaja dokumentatsioon.
  6. Seadistage see tõlkimiseks Sphinx Internationalization'i abil.

Õppisin palju rohkem VideoLANi organisatsiooni ja VLC kohta, sain teada, et VLC-l on rohkem funktsioone, millest ma kunagi ei teadnud, ning õppisin kasutama Sphinxi dokumentatsiooniplatvormi ja teksti ümber korraldama.

Ka minu tehniline kirjutamisoskus paranes tohutult. Üldiselt oli Google'i dokumentide hooajal osalemine üks parimaid asju, mis minuga 2019. aastal juhtus.

Kasulikud ressursid

Allpool leiate kasulike ressursside loendi, mis aitab teil programmi Season of Docs ja tehnilise kirjutamise kohta lisateavet saada.

  • Minu dokumentide aktsepteeritud hooaja ettepanek
  • Google'i dokumentide hooaja projekti aruanne
  • Avatud lähtekoodiga kaastööd: kasvu katalüsaator
  • Tehnilise kirjaniku juhend
  • Kanali Docs Slack hooaeg
  • Äge tehniline kirjutamine

Kas see artikkel meeldib teile? Jälgige Twitteris @Didicodes.