Kuinka murtaa Google-dokumenttien kausi 2020 -prosessille

Vuosien mittaan tutkimukset ovat osoittaneet hyvän dokumentoinnin tärkeyden kehittäjien valitsemassa ja käyttämässä avointa lähdekoodia.

Vuonna 2019 käynnistetyssä Google Season of Docs (GSoD) -ohjelmassa ohjelma sai lähes 450 teknisen kirjoittajan hakemusta ja yli 50 teknistä kirjoittajaa hyväksyttiin.

Yhtenä teknisistä kirjoittajista, jotka hyväksyttiin osallistumaan Google Season of Docs -ohjelmaan, ajattelin jakaa oivalluksia siitä, miten valmistella ja luoda vahva sovellus GSoD-ohjelmalle.

Sisällysluettelo

  • Mikä on Google-dokumenttien kausi?
  • Kuka voi osallistua ohjelmaan?
  • Osallistumisen edut
  • 5 vinkkiä GSoD-sovelluksesi ässäämiseen
  • Minun GSoD-kokemukseni
  • Hyödyllisiä resursseja

Mikä on Google-dokumenttien kausi?

Season of Docs on Googlen vuosittain järjestämä ohjelma. Sen tavoitteena on tuoda tekniset kirjoittajat ja avoimen lähdekoodin organisaatiot edistämään yhteistyötä ja dokumentaation parantamista avoimen lähdekoodin tilassa.

Tämä aloite on erittäin tärkeä, koska avoimen lähdekoodin projektin dokumentaatio tarjoaa käyttäjille mahdollisuuden paitsi ymmärtää projektia myös osallistua siihen.

Ohjelman aikana hyväksytyt tekniset kirjoittajat käyttävät 3-5 kuukautta joko uuden asiakirjajoukon rakentamiseen, olemassa olevien asiakirjojen rakenteen parantamiseen, kaivatun opetusohjelman kehittämiseen tai avoimen lähdekoodin organisaation osallistumisprosessien ja oppaiden parantamiseen.

Kuka voi osallistua ohjelmaan?

Googlen sääntöjen mukaan sinun on oltava vähintään 18-vuotias rekisteröinnin yhteydessä. Sinulla on oltava myös aikaisempi kokemus teknisestä kirjoittajasta ja sinulla on oltava oikeus työskennellä asuinmaassasi.

Jos täytät nämä vaatimukset, voit hakea osallistumista Google Season of Docs -ohjelmaan.

Osallistumisen edut

Dokumenttien Season-ohjelmaan osallistumisella on niin monia etuja. Jotkut ovat:

Voit saada stipendin

Kun olet suorittanut Google-dokumenttien kausi-ohjelman, Google maksaa sinulle stipendin. On tärkeää huomata, että tämä apuraha on vapaaehtoinen, joten sinun on ilmoitettava, että haluat palkan hakuvaiheessa.

Stipendin määrä lasketaan sijaintisi perusteella. Katso täältä lisätietoja stipendeistä.

Parannat taitojasi

Toinen ilmeinen hyöty osallistumisesta Google Season of Docs -ohjelmaan on, että sen avulla voit parantaa taitojasi teknisenä kirjoittajana.

Laajennat verkkoasi

Sen lisäksi, että olet kehittynyt teknisenä kirjoittajana, saat myös mahdollisuuden työskennellä ihmisten kanssa, jotka tekevät hämmästyttäviä asioita avoimen lähdekoodin tilassa.

Minun tapauksessani sain tilaisuuden työskennellä VideoLAN-organisaation kanssa, mikä tarkoitti sitä, että minun piti tehdä tiivistä yhteistyötä organisaation presidentin ja tärkeimpien projektien avustajien kanssa.

Saat suosituksia ja viitteitä

Kun haet mihin tahansa työhön, hyvä suosituskirje auttaa usein vahvistamaan hakemustasi.

Tiivis yhteistyö dokumenttien kausi -projektin kanssa tarjoaa mahdollisuuden saada runsaasti suosituksia ja viitteitä.

Saat pääsyn tuleviin mahdollisuuksiin

Jos olet valmis hakemaan teknistä kirjoitusroolia Googlesta, mukaan lukien kaaviossasi Season of Docs -kokemus antaa sinulle enemmän etuja verrattuna muihin hakijoihin.

Sinusta tulee avoimen lähdekoodin avustaja

Kaikkien edellä mainittujen etujen lisäksi osallistuminen Docs-kauden ohjelmaan tarkoittaa, että saat osallistua avoimen lähdekoodin projekteihin. Tämä auttaa maailmaa kumoamaan stereotypian, jonka mukaan avoimen lähdekoodin maksut ovat tarkoitettu vain ohjelmistokehittäjille.

5 vinkkiä GSoD-sovelluksesi ässäämiseen

Tässä on 5 vinkkiä, joiden avulla voit valmistautua ja luoda vahvan sovelluksen Season of Docs -ohjelmaan.

Luo ja julkaise artikkeleita blogissasi

Yksi tärkeimmistä kriteereistä saada tekninen kirjoittaja Google Season of Docs -ohjelmaan on kyky osoittaa, että sinulla on aikaisempi kirjoituskokemus.

Google ja ehdotetut projektin mentorit, joiden kanssa haluat työskennellä, on oltava vakuuttuneita siitä, että olet oikea henkilö työskentelemään projektin parissa. Tämä tarkoittaa, että he haluavat nähdä hyvän määrän hyvin kirjoitettuja asiakirjoja ja luomiasi artikkeleita.

Onneksi ei ole liian myöhäistä luoda blogia tai julkaista enemmän sisältöä jo olemassa olevassa blogissasi.

Jos sinulla on jo blogi, kannattaa julkaista tarkemmin kirjoitettuja artikkeleita ennen ehdotustasi, sen aikana ja sen jälkeen, kun olet lähettänyt ehdotuksesi. Jos sinulla ei ole blogia, ei ole vielä liian myöhäistä luoda blogi käyttämällä Hashnoden Devblogia tai haluamaasi alustaa ja julkaista myös hyvin kirjoitettuja artikkeleita.

Valitse oikea avoimen lähdekoodin projekti

Rehellisesti, en voi korostaa liikaa oikean avoimen lähdekoodin projektin valinnan tärkeyttä. Tämä johtuu siitä, että sillä on vahva rooli saada sinut ohjelmaan.

Tässä ovat ajatukseni oikean projektin valitsemisesta:

  • Käy läpi kaikki hyväksytyt projektit ja yritä valita vähintään 5 projektia, joista olet kiinnostunut.
  • Kun olet valinnut vähintään 5 projektia, skannaa uudelleen ja pienennä projektit enintään 3 projektiin ja vähintään 2 projektiin.
  • Vaikka voi olla järkevää keskittyä yhteen projektiin hakuvaiheessa, kehotan teitä hakemaan vähintään kahta hanketta, jotta parannat mahdollisuuksiasi saada hyväksyntä ainakin yhteen projektiin.
  • Liity jokaisen valitsemasi projektin kohdalla organisaation viestintäkanavaan ja ilmoita projektin ylläpitäjille kiinnostuksesi kyseiseen projektiin. Tällä tavalla pystyt luomaan suhteen itsesi ja mentorin välille. Huomaa myös, että mentorit eivät valitse ihmisiä vain siksi, että heillä on tarvittavat taidot. He valitsevat myös hakijat, koska uskovat voivansa työskennellä heidän kanssaan. Joten kun lähetät viestin mentorille, kerro tarkalleen, mitä tarvitset, ja mikä tärkeintä, älä järkyttyneestä siitä, että he eivät vastanneet heti, koska suurin osa mentoreista on vapaaehtoisia, joilla on muuta kokopäiväistä työtä.
  • Älä odota, että ruokitaan lusikalla. Suorita paljon tutkimusta projektista. Löydä ja ymmärrä kaikki mitä sinun tarvitsee tietää, ja jos sinulla on kysyttävää, ota yhteyttä ehdotettuun projektin mentoriin apua tai pyydä muita yhteisön jäseniä.
  • Mikä tärkeintä, kirjoita ylös kaikki tutkimuksesi aikana löytämäsi tiedot, joista on hyötyä, jos sinut hyväksytään työskentelemään projektin parissa, tai tietoja, jotka auttavat parantamaan ehdotustasi.

Kirjoita ehdotus

Monet ihmiset eivät tiedä tätä, mutta ehdotuksen kirjoittaminen on elintärkeää. Se antaa sinulle selkeän käsityksen projektin tavoitteesta, aikataulusta, joka kuluu projektin loppuun saattamiseen, mitä sinun on tiedettävä, ja niin edelleen.

Sen lisäksi ehdotuksen kirjoittaminen osoittaa myös mentorillesi projektisi tavoitteet, miksi uskot olevasi oikea henkilö roolille, kokemuksellesi, projektin aikatauluille ja muulle.

Kun olet kirjoittanut ehdotuksesi, lähetä se projektin mentorille tarkistettavaksi. Heidän katsauksensa auttaa sinua tuntemaan projektivaatimukset mentorin näkökulmasta. Olen lisännyt linkin Google Season of Docs -ehdotukseeni Resurssit-osioon.

Tee vähintään yksi panos avoimen lähdekoodin organisaatioon

Dokumenttien kausi -ohjelma ei ole kuin Google Summer of Code, jossa sinun on tehtävä vähintään yksi osallistuminen kiinnostavaan avoimen lähdekoodin projektiin. Mutta lahjoituksen tekeminen voi varmasti parantaa mahdollisuuttasi saada hyväksyntä, joten yritä tehdä niin.

Pysy aktiivisena yhteisössä hakemuksen määräajan jälkeen

Kun olet lähettänyt hakemuksesi, yritä pysyä aktiivisena kyseisessä avoimen lähdekoodin organisaatiossa. Tämä osoittaa mentoreille, että olet intohimoisesti projektiin ja tuohon avoimen lähdekoodin yhteisöön.

Minun GSoD-kokemukseni

Viime vuonna GSoD-ohjelman aikana minulla oli mahdollisuus työskennellä VideoLAN-organisaation kanssa VLC-käyttäjän dokumentaation modernisointi (uudelleenkirjoittaminen) projektissa.

Kun VideoLAN-organisaatio oli hyväksynyt ehdotukseni, mentorini ja minä sovimme tavoitteista, jotka minun odotettiin saavuttavan Google Season of Docs -ohjelman aikana.

Nämä olivat tavoitteita:

  1. Rakenna dokumentaatio uudelleen.
  2. Päivitä dokumentaatio VLC: n nykyaikaisiin versioihin.
  3. Siirrä käyttäjän dokumentaatio Gitlabiin Sphinxin ja ReadtheDocsin avulla.
  4. Poista vanhentuneet kuvat ja tiedot.
  5. Kirjoita käyttäjädokumentaatio uudelleen ymmärrettäväksi uudelleen.
  6. Määritä se käännettäväksi Sphinx Internationalization -sovelluksella.

Olen oppinut paljon enemmän VideoLAN-organisaatiosta ja VLC: stä, huomasin, että VLC: llä on enemmän ominaisuuksia, joista en ole koskaan tiennyt, ja opin, kuinka käyttää Sphinx-dokumentaatioalustaa ja jäsentää tekstiä.

Myös tekninen kirjoitustaitoni parani valtavasti. Kaiken kaikkiaan osallistuminen Google Season of Docs -ohjelmaan oli yksi parhaista asioista, mitä minulle tapahtui vuonna 2019.

Hyödyllisiä resursseja

Alla on luettelo hyödyllisistä resursseista, joiden avulla voit oppia lisää Dokumenttien kausi -ohjelmasta ja teknisestä kirjoittamisesta.

  • Hyväksytty dokumenttikausi -ehdotukseni
  • Google-dokumenttien kausiprojektiraportti
  • Avoimen lähdekoodin julkaisut: Kasvun katalysaattori
  • Teknisen kirjoittajan opas
  • Docs Slack -kanavan kausi
  • Mahtava tekninen kirjoittaminen

Tykkää tämä artikkeli? Seuraa @Didicodes Twitterissä.