Hogyan lehet feltörni a Google szezonja a Docs alkalmazás folyamatát 2020-ra

Az évek során a felmérések megmutatták a jó dokumentáció fontosságát abban, hogy a fejlesztők hogyan választják és használják a nyílt forrást.

A Google Season of Docs (GSoD) 2019-es kezdő programjában a program közel 450 műszaki írói kérelmet kapott, és több mint 50 műszaki írót fogadtak el.

Mint az egyik műszaki író, akit elfogadtak a Google Season of Docs programban való részvételre, gondoltam megosztani néhány betekintést a GSoD program erős alkalmazásának elkészítéséről és létrehozásáról.

Tartalomjegyzék

  • Mi a Google Dokumentumok évada?
  • Ki jogosult részt venni a programban?
  • A részvétel előnyei
  • 5 tipp a GSoD alkalmazás elkészítéséhez
  • GSoD tapasztalatom
  • Hasznos források

Mi a Google Dokumentumok évada?

A Season of Docs a Google által szervezett éves program. Célja a műszaki írók és a nyílt forráskódú szervezetek összefogása az együttműködés és a dokumentáció fejlesztésének elősegítése érdekében a nyílt forráskódú térben.

Ez a kezdeményezés rendkívül fontos, mert egy nyílt forráskódú projekt dokumentációja lehetőséget nyújt a felhasználók számára, hogy ne csak megértsék a projektet, hanem hozzájáruljanak hozzá.

A program során az elfogadott műszaki írók 3-5 hónapot töltenek egy új dokumentumkészlet felépítésével, a meglévő dokumentumok szerkezetének fejlesztésével, egy nagyon szükséges oktatóanyag kidolgozásával, vagy egy nyílt forráskódú szervezet hozzájárulási folyamatainak és útmutatóinak fejlesztésével.

Ki jogosult részt venni a programban?

A Google szabályai szerint a regisztrációkor legalább 18 évesnek kell lennie. Szüksége van előzetes műszaki írói tapasztalatra, és képesnek kell lennie arra, hogy a lakóhelye szerinti országban dolgozzon.

Ha megfelel ezeknek a képesítéseknek, akkor jelentkezhet a Google Dokumentumok szezonja programban való részvételre.

A részvétel előnyei

Olyan sok előnnyel jár, ha részt veszünk a Dokumentumok szezonja programban. Néhányan:

Kaphat ösztöndíjat

Miután befejezte a Google Dokumentumok szezonja programot, a Google fizet ösztöndíjat. Fontos megjegyezni, hogy ez a támogatás nem kötelező, ezért jeleznie kell, hogy fizetni szeretne a pályázati szakaszban.

A ösztöndíj összegét az Ön tartózkodási helye alapján számoljuk ki. A támogatásokról itt talál részletes információt.

Javítja képességeit

A Google Dokumentumok szezonja programban való részvétel másik nyilvánvaló előnye, hogy lehetővé teszi technikai íróként való fejlesztését.

Bővíti hálózatát

A technikai íróként való fejlődésen kívül lehetőséget kap arra is, hogy olyan emberekkel dolgozzon együtt, akik csodálatos dolgokat csinálnak a nyílt forráskódú térben.

Esetemben alkalmat kaptam a VideoLAN szervezettel való együttműködésre, ami azt jelentette, hogy szorosan együtt kellett működnöm a szervezet elnökével és a projektek főbb közreműködőivel.

Javaslatokat és beutalókat kaphat

Bármely állásra történő jelentkezéskor a jó ajánlólevél birtoklása gyakran segít a jelentkezés megerősítésében.

Szoros együttműködés a dokumentumok szezonja mentorával lehetőséget kínál az ajánlások és az ajánlások gazdag forrásának megszerzésére.

Hozzáférhet a jövőbeli lehetőségekhez

Ha készen áll arra, hogy technikai írói szerepet vállaljon a Google-nál, az önök összefoglalójában a Season of Docs-os tapasztalatok felvétele több előnnyel jár, mint más pályázók számára.

Ön nyílt forráskódú közreműködővé válik

A fent említett előnyökön kívül a Docs program szezonjában való részvétel azt jelenti, hogy hozzájárulhat a nyílt forráskódú projektekhez. Ez segít a világban elvetni azt a sztereotípiát, miszerint az Open Source Contributions csak a szoftverfejlesztőknek szól.

5 tipp a GSoD alkalmazás elkészítéséhez

Íme 5 tipp, amelyek segítenek előkészíteni és létrehozni egy erős alkalmazást a Dokumentumok szezonja programhoz.

Készítsen és tegyen közzé cikkeket a blogján

Az egyik legfontosabb kritérium ahhoz, hogy technikai íróként elfogadják a Google Dokumentumok évada programot, az a képesség, hogy megmutassa, hogy rendelkezik korábbi írói tapasztalattal.

A Google-nek és a projekt javasolt mentorainak meg kell győződniük arról, hogy Ön a megfelelő ember a projekten való munkához. Ez azt jelenti, hogy szép számú, jól megírt dokumentációt és cikket szeretnének látni, amelyet Ön készített.

Szerencsére még nem késő blogot létrehozni vagy több tartalmat közzétenni a már meglévő blogján.

Ha már van blogja, érdemes javaslata benyújtása előtt, közben és utána több jól megírt cikket közzétenni. Ha még nincs blogja, akkor sem késő létrehozni egyet a Hashnode Devblog vagy az Ön által preferált platform segítségével, és jól megírt cikkeket is közzétenni.

Válassza ki a megfelelő nyílt forráskódú projektet

Őszintén szólva nem tudom túl hangsúlyozni a megfelelő nyílt forráskódú projekt kiválasztásának fontosságát. Ennek oka, hogy nagy szerepe van abban, hogy bekerüljön a programba.

Itt vannak a gondolataim a megfelelő projekt kiválasztásával kapcsolatban:

  • Végezze el az összes jóváhagyott projektet, és próbáljon kiválasztani legalább 5 projektet, amely érdekli.
  • Legalább 5 projekt kiválasztása után szkennelje át újra, és csökkentse a projekteket legfeljebb 3 projektre és minimum 2 projektre.
  • Noha indokolt lehet egy projektre koncentrálni a pályázati szakaszban, arra biztatom Önt, hogy legalább két projektre pályázzon, hogy javítsa esélyeit arra, hogy legalább egy projektre befogadjanak.
  • Minden egyes kiválasztott projekthez csatlakozzon a szervezetek kommunikációs csatornájához, és tájékoztassa a projekt fenntartóit arról, hogy érdeklődik az adott projekt iránt. Így képes lesz kapcsolatot kialakítani saját maga és a mentor között. Vegye figyelembe azt is, hogy a mentorok nem csak azért választják az embereket, mert rendelkeznek a szükséges készségekkel. Azért is választanak pályázókat, mert úgy gondolják, hogy velük is együttműködhetnek. Tehát, amikor üzenetet küld egy mentornak, legyen egyértelmű, hogy pontosan mire van szüksége, és ami a legfontosabb: ne háborodjon fel azon, hogy nem azonnal válaszoltak, mert a mentorok többsége önkéntes, aki más teljes munkaidős munkát végez.
  • Ne várja meg, hogy kanállal etesse. Végezzen sok kutatást a projekttel kapcsolatban. Fedezze fel és értse meg mindazt, amit tudnia kell, és ha bármilyen kérdése van, forduljon segítségért a projekt javasolt mentorához, vagy kérjen a közösség többi tagjától.
  • A legfontosabb, hogy írjon fel mindent, amit felfedez a kutatás során, és amely hasznos lehet, ha elfogadják a projekt munkáját, vagy információkat, amelyek elősegítik a javaslat javítását.

Írjon javaslatot

Sokan nem tudják ezt, de a javaslat megírása létfontosságú. Világos megértést ad a projekt céljáról, az idővonalról, amelyre a projekt befejezése szükséges, amit tudnia kell stb.

Ettől eltekintve, egy javaslat megírása megmutatja mentorának a projekt céljait, miért gondolja, hogy Ön a megfelelő ember a szerephez, a tapasztalataihoz, a projekt ütemezéséhez és egyebekhez.

A javaslat megírása után küldje el a projekt mentorának felülvizsgálatra. Áttekintésük segít megismerni a projekt követelményeit a mentor szempontjából. Hozzáadtam egy linket a Google Dokumentumok szezonjavaslatomhoz az Erőforrások részben.

Tegyen legalább egy hozzájárulást a nyílt forráskódú szervezethez

A Dokumentumok szezonja nem olyan, mint a Google Summer of Code, ahol legalább egy hozzájárulást kell tennie az érdeklődő nyílt forráskódú projekthez. De a hozzájárulás mindenképpen javíthatja az esélyét annak, hogy elfogadják, ezért próbáld meg.

Legyen aktív a közösségben a jelentkezési határidő lejárta után

A pályázat benyújtása után próbáljon aktív maradni abban a nyílt forráskódú szervezetben. Ez megmutatja a mentoroknak, hogy rajongsz a projektért és általában a nyílt forráskódú közösségért.

GSoD tapasztalatom

A tavalyi GSoD program során alkalmam volt együttműködni a VideoLAN szervezettel a VLC felhasználói dokumentációjának modernizálása (átírása) projekten.

Miután javaslatomat elfogadta a VideoLAN szervezet, mentoraimmal megegyeztünk azokban a célokban, amelyeket várhatóan el fogok érni a Google Dokumentumok szezonja alatt.

Ezek voltak a céljaim:

  1. Szerelje át a dokumentációt.
  2. Frissítse a dokumentációt, hogy illeszkedjen a VLC modern verzióihoz.
  3. Migrálja a felhasználói dokumentációt a Gitlab-ba a Sphinx és a ReadtheDocs segítségével.
  4. Távolítsa el az elavult képeket és információkat.
  5. Írja át a felhasználói dokumentációt, hogy könnyen érthető legyen.
  6. Állítsa be fordításra a Sphinx Internationalization segítségével.

Sokkal többet tudtam meg a VideoLAN szervezetről és a VLC-ről, megtudtam, hogy a VLC-nek több olyan funkciója van, amelyekről soha nem tudtam, és megtanultam a Sphinx dokumentációs platform használatát és a szöveg átszervezését.

A technikai íráskészségem is rendkívül javult. Összességében a Google Season of Docs programban való részvétel volt az egyik legjobb dolog, ami velem történt 2019-ben.

Hasznos források

Az alábbiakban megtalálja a hasznos források listáját, amelyek segítenek többet megtudni a Dokumentumok szezonja programról és a Műszaki írásról.

  • A dokumentumok elfogadott évadára vonatkozó javaslatom
  • A Google Dokumentumok szezonja projektjelentése
  • Nyílt forráskódú hozzájárulások: A növekedés katalizátora
  • Műszaki írói útmutató
  • A Docs Slack csatorna évada
  • Félelmetes műszaki írás

Tetszik ez a cikk? Kövesse a @Didicodes alkalmazást a Twitteren.