Kā uzlauzt Google dokumentu sezonas pieteikšanās procesu 2020. gadam

Gadu gaitā aptaujas ir parādījušas labas dokumentācijas nozīmi tajā, kā izstrādātāji izvēlas un izmanto atvērto pirmkodu.

Inaugurācijas programmā Google dokumentu sezona (GSoD) 2019. gadā programma saņēma gandrīz 450 tehnisko rakstnieku pieteikumus un tika pieņemti vairāk nekā 50 tehniski rakstnieki.

Kā viens no tehniskajiem rakstniekiem, kurš tika pieņemts dalībai programmā Google dokumentu sezona, es domāju dalīties dažās atziņās par to, kā sagatavot un izveidot spēcīgu GSoD programmas lietojumprogrammu.

Satura rādītājs

  • Kas ir Google dokumentu sezona?
  • Kas ir tiesīgs piedalīties programmā?
  • Dalības priekšrocības
  • 5 padomi, kā padarīt savu GSoD lietojumprogrammu
  • Mana GSoD pieredze
  • Noderīgi resursi

Kas ir Google dokumentu sezona?

Dokumentu sezona ir Google organizēta gada programma. Tās mērķis ir apvienot tehniskos rakstniekus un atvērtā pirmkoda organizācijas, lai veicinātu sadarbību un dokumentācijas uzlabošanu atvērtā koda telpā.

Šī iniciatīva ir ārkārtīgi svarīga, jo atvērtā pirmkoda projekta dokumentācija nodrošina iespēju lietotājiem ne tikai izprast projektu, bet arī dot ieguldījumu tajā.

Programmas laikā pieņemtie tehniskie autori 3-5 mēnešus pavada, veidojot jaunu dokumentu kopu, uzlabojot esošo dokumentu struktūru, izstrādājot tik nepieciešamo apmācību vai uzlabojot atvērtā pirmkoda organizācijas ieguldījumu procesus un rokasgrāmatas.

Kas ir tiesīgs piedalīties programmā?

Saskaņā ar Google noteikumiem reģistrācijas laikā jums jābūt vismaz 18 gadus vecam. Jums jābūt arī iepriekšējai tehniskā autora pieredzei un jābūt tiesīgai strādāt savā dzīvesvietas valstī.

Ja atbilstat šīm kvalifikācijām, varat pieteikties dalībai programmā Google dokumentu sezona.

Dalības priekšrocības

Piedaloties Dokumentu sezonas programmā, ir tik daudz priekšrocību. Daži no tiem ir:

Jūs varat saņemt stipendiju

Kad esat pabeidzis programmu Google dokumentu sezona, jūs saņemat Google stipendiju. Ir svarīgi atzīmēt, ka šī stipendija nav obligāta, tāpēc jums ir jānorāda, ka vēlaties saņemt samaksu pieteikšanās posmā.

Stipendijas summa tiek aprēķināta, pamatojoties uz jūsu atrašanās vietu. Pilnu informāciju par stipendijām skatiet šeit.

Jūs uzlabojat savas prasmes

Vēl viens acīmredzams ieguvums no dalības programmā Google dokumentu sezona ir tas, ka tas ļauj uzlabot tehniskā rakstnieka prasmes.

Jūs paplašināt savu tīklu

Izņemot pilnveidošanos kā tehniskais autors, jūs arī iegūstat iespēju strādāt ar cilvēkiem, kas dara apbrīnojamas lietas atvērtā koda telpā.

Manā gadījumā es saņēmu iespēju strādāt ar VideoLAN organizāciju, un tas nozīmēja, ka man bija cieši jāsadarbojas ar organizācijas prezidentu un galvenajiem projektu atbalstītājiem.

Jūs varat saņemt ieteikumus un ieteikumus

Piesakoties jebkuram darbam, laba ieteikuma vēstule bieži palīdz stiprināt jūsu pieteikumu.

Cieši sadarbojoties ar mentoru projekta Sezona projektā, ir iespēja iegūt bagātīgu ieteikumu un ieteikumu avotu.

Jūs iegūstat piekļuvi nākotnes iespējām

Ja esat gatavs pieteikties tehniskai rakstīšanas lomai Google, iekļaujot kopsavilkumā savu Sezonas dokumentu pieredzi, iegūsiet vairāk priekšrocību salīdzinājumā ar citiem pretendentiem.

Jūs kļūstat par atvērtā koda līdzautoru

Neatkarīgi no visiem iepriekšminētajiem ieguvumiem, piedaloties Docs programmas sezonā, jūs varat dot ieguldījumu atvērtā pirmkoda projektos. Tas palīdz pasaulei noraidīt stereotipu, ka atvērtā koda ieguldījumi ir domāti tikai programmatūras izstrādātājiem.

5 padomi, kā padarīt savu GSoD lietojumprogrammu

Šeit ir 5 padomi, kas palīdzēs sagatavoties un izveidot spēcīgu lietojumprogrammu dokumentu sezonai.

Veidojiet un publicējiet rakstus savā emuārā

Viens no vissvarīgākajiem kritērijiem, lai Google dokumentu sezona tiktu pieņemts kā tehniskais autors, ir spēja pierādīt, ka jums ir iepriekšēja rakstīšanas pieredze.

Google un ierosinātajiem projekta mentoriem, ar kuriem vēlaties strādāt, jābūt pārliecinātiem, ka esat īstā persona, kas strādā pie projekta. Tas nozīmē, ka viņi vēlas redzēt labu skaitu labi uzrakstītas dokumentācijas un jūsu izveidoto rakstu.

Par laimi, nav par vēlu izveidot emuāru vai publicēt vairāk satura jau esošajā emuārā.

Ja jums jau ir emuārs, ieteicams pirms priekšlikuma iesniegšanas, tā laikā un pēc tam publicēt vairāk labi uzrakstītus rakstus. Ja jums nav neviena emuāra, joprojām nav par vēlu to izveidot, izmantojot Hashnode's Devblog vai vēlamo platformu, kā arī publicēt labi rakstītus rakstus.

Izvēlieties pareizo atvērtā koda projektu

Godīgi sakot, es nevaru pārāk uzsvērt pareizā atvērtā koda projekta izvēles nozīmi. Tas ir tāpēc, ka tai ir liela loma, iekļaujot jūs programmā.

Šīs ir manas domas par pareizā projekta izvēli:

  • Izskatiet visus apstiprinātos projektus un mēģiniet atlasīt vismaz 5 jūs interesējošus projektus.
  • Pēc vismaz 5 projektu atlases skenējiet vēlreiz un samaziniet projektus līdz maksimāli 3 projektiem un vismaz 2 projektiem.
  • Lai gan pieteikšanās posmā var būt saprātīgi koncentrēties uz vienu projektu, es iesaku pieteikties vismaz diviem projektiem, lai uzlabotu izredzes tikt pieņemtiem vismaz vienam projektam.
  • Katram jūsu izvēlētajam projektam pievienojieties organizācijas komunikācijas kanālam un informējiet projekta uzturētājus par jūsu interesi par šo projektu. Tādā veidā jūs varēsiet nodibināt attiecības starp sevi un mentoru. Ņemiet vērā arī to, ka mentori neizvēlas cilvēkus tikai tāpēc, ka viņiem ir nepieciešamās prasmes. Viņi arī atlasa pretendentus, jo uzskata, ka var strādāt arī ar viņiem. Tāpēc, nosūtot ziņojumu mentoram, precīzi formulējiet tieši to, kas jums nepieciešams, un pats galvenais - neapmieriniet, ka viņi neatbildēja nekavējoties, jo lielākā daļa mentoru ir brīvprātīgie, kuriem ir citi pilnas slodzes darbi.
  • Negaidiet barošanu ar karoti. Veiciet daudz pētījumu par projektu. Atklājiet un saprotiet visu, kas jums jāzina, un, ja jums ir kādas bažas, sazinieties ar ierosināto šī projekta mentoru pēc palīdzības vai lūdziet citus šīs kopienas locekļus.
  • Vissvarīgākais ir pierakstīt visu, ko atklāj pētījuma laikā, un tas būs noderīgi, ja tevi pieņems strādāt pie projekta, vai informāciju, kas palīdzēs uzlabot tavu priekšlikumu.

Uzrakstiet priekšlikumu

Daudzi cilvēki to nezina, taču priekšlikuma rakstīšana ir vitāli nepieciešama. Tas ļauj jums skaidri saprast projekta mērķi, laika grafiku, kas jums būs nepieciešams, lai pabeigtu projektu, kas jums jāzina utt.

Papildus tam, rakstot priekšlikumu, jūsu mentoram tiek parādīti arī jūsu projekta mērķi, kāpēc jūs uzskatāt, ka esat īstā persona lomai, savai pieredzei, projekta grafikiem un daudz ko citu.

Pēc priekšlikuma rakstīšanas nosūtiet to projekta mentoram pārskatīšanai. Viņu pārskats palīdzēs jums uzzināt projekta prasības no mentora viedokļa. Resursu sadaļā esmu pievienojis saiti uz savu Google dokumentu sezonas priekšlikumu.

Veiciet vismaz vienu ieguldījumu atvērtā pirmkoda organizācijā

Dokumentu sezona nav līdzīga Google Summer of Code, kur jums ir jāveic vismaz viens ieguldījums interesējošajā atvērtā pirmkoda projektā. Bet ieguldījums noteikti var uzlabot jūsu izredzes tikt pieņemtam, tāpēc mēģiniet to izdarīt.

Palieciet aktīvs sabiedrībā pēc pieteikšanās termiņa beigām

Pēc pieteikuma iesniegšanas mēģiniet palikt aktīvs šajā atvērtā pirmkoda organizācijā. Tas parāda mentoriem, ka jūs aizraujat šo projektu un šo atvērtā pirmkoda kopienu kopumā.

Mana GSoD pieredze

Pagājušā gada GSoD programmas laikā man bija izdevība strādāt ar VideoLAN organizāciju pie projekta Modernizēt (pārrakstīt) VLC lietotāja dokumentāciju.

Pēc tam, kad VideoLAN organizācija bija akceptējusi manu priekšlikumu, mēs ar mentoriem vienojāmies par mērķiem, kurus man bija paredzēts sasniegt Google dokumentu sezonas laikā.

Šie bija mani mērķi:

  1. Pārstrukturējiet dokumentāciju.
  2. Atjauniniet dokumentāciju, lai tā atbilstu mūsdienu VLC versijām.
  3. Migrējiet lietotāja dokumentāciju uz Gitlab, izmantojot Sphinx un ReadtheDocs.
  4. Noņemiet novecojušos attēlus un informāciju.
  5. Pārrakstiet lietotāja dokumentāciju, lai tā būtu viegli saprotama.
  6. Iestatiet to tulkošanai, izmantojot Sphinx Internationalization.

Es uzzināju daudz vairāk par VideoLAN organizāciju un VLC, es uzzināju, ka VLC ir vairāk funkciju, par kurām es nekad nezināju, un es uzzināju, kā izmantot Sphinx dokumentācijas platformu un pārstrukturēt tekstu.

Arī manas tehniskās rakstīšanas prasmes ir ļoti uzlabojušās. Kopumā dalība Google dokumentu sezonā bija viena no labākajām lietām, kas ar mani notika 2019. gadā.

Noderīgi resursi

Zemāk atrodiet noderīgu resursu sarakstu, kas palīdzēs jums uzzināt vairāk par programmu Dokumentu sezona un Tehnisko rakstīšanu.

  • Mans priekšlikums par pieņemto dokumentu sezonu
  • Google dokumentu sezonas projekta pārskats
  • Atvērtā koda ieguldījums: izaugsmes katalizators
  • Tehnisko rakstnieku rokasgrāmata
  • Kanāla Docs Slack sezona
  • Lieliska tehniskā rakstīšana

Patīk šis raksts? Seko Twitter vietnē @Didicodes.