Kako pisati o programskih jezikih brez tehničnega predznanja

Uvod

Pisanje je bila od nekdaj moja strast. Ko sem dobila službo pisca za splet3 pri podjetju, ki se ukvarja z izobraževalno tehnologijo, sem bila v devetih očeh. Po podatkih Social Media Today 77 % uporabnikov interneta bere bloge. Tako je bila moja zaposlitev priložnost, da svetu predstavim svoje delo.

Medtem ko sem sanjaril o tem, kako bom v naslednjih nekaj mesecih pridobil zvesto občinstvo in mednarodne bralce, me je moj vodja prosil, naj napišem vodnike o različnih programskih jezikih, ki se pogosto uporabljajo na področju Web3. Ker prihajam iz netehničnega okolja, se mi je to zdelo kot težka naloga.

Vendar sem po številnih poskusih in napakah sčasoma prišel do točke, ko sem izdelal recept za pisanje dolgih priročnikov o različnih programskih jezikih, in to na način, ki bi ga napisala oseba s tehničnim ozadjem.

V tem blogu bom delil pet nasvetov, ki so mi prihranili energijo in čas ter mi pomagali pri pisanju tehničnih in vsebinsko pravilnih vodnikov, ki se lahko uvrstijo v Googlu.

(Slika: Metaschool)

Zakaj bi morali pisati vodnike o tehničnih temah?

Preden v tem vodniku preidemo na formulo, najprej razumimo, zakaj je pisanje vodnikov o tehničnih temah pomembno in lahko prinese dobre rezultate za vaš blog.

Najprej so tehnični vodniki odličen način za povezovanje z občinstvom, deljenje znanja in spretnosti. Vendar pa je tehnična vsebina tudi zelo specifična za določeno nišo. Če ste lastnik bloga o življenjskem slogu, takšnih vodnikov verjetno ne boste pisali. Vendar pa z novimi tehnološkimi dosežki, kot sta umetna inteligenca in veriženje blokov, ki pridobivajo na veljavi, tehnični blogi doživljajo porast. Številni imajo svoje lastne izdelke, ki temeljijo na umetni inteligenci. Tu lahko tehnično pisanje odigra veliko vlogo pri usmerjanju prometa na vaš blog in izdelek.

Drugič, nedvomno je v današnjem času, ko se želite naučiti nekaj tehničnega, YouTube vaš cilj. Na voljo je več sto tisoč videoposnetkov in učnih gradiv. Prostor je precej zasičen, če želite. Morda se zdaj sprašujete, da če je potrebno gradivo že na voljo na YouTubu, zakaj bi se kdo zatekal k pisanju dolgih vodnikov? No, to je vaš odgovor. Vsi okoli vas bolj ali manj razmišljajo enako. Ljudje se osredotočajo na ustvarjanje vedno več video vsebin in se ne zavedajo, da lahko občinstvo ustvarijo tudi s pisanjem vsebin.

Tretjič, če govorimo o programskih jezikih, na internetu ni veliko pisnih priročnikov. Dokumentacija, ki je na voljo na uradnih spletnih straneh, je ponavadi obširna in vsebuje veliko informacij. Vodiči v bistvu združujejo vse razpoložljive informacije iz obsežne dokumentacije jezika, jih povzemajo in delijo manj obsežno in pregledno različico, ki je namenjena občinstvu, ki raje bere.

Če imate podjetje, ki se vrti okoli tehnologije, spleta 3 in umetne inteligence, je pisanje vodnikov najhitrejši način, da vam pomaga pri uvrstitvi za različne ključne besede in pripelje vaše podjetje v ospredje. To je nekaj razlogov, zakaj bi morali razmisliti o pisanju vodnikov o tehničnih temah, če imate blog ali podjetje v podobni niši.

Nasvet #1 - Preudarno izberite jezike, v katerih želite pisati vodnike

Najprej je treba ravnati preudarno, saj ne želite napisati vodnika o jeziku, kot je Solidity, za katerega je že tako težko najti mesto. Zato morate začeti s temeljito raziskavo ključnih besed, preden začnete pisati vodnike o nekem jeziku. Čarobna formula za ključne besede z nizkimi stroški je: velik obseg iskanja in nizka težavnost. Pri tem lahko uporabite orodje Ranktrackerjev iskalnik ključnih besed. Preverite lahko tudi število že objavljenih vodnikov v polni dolžini, da dobite predstavo o svojih konkurentih. Pravzaprav lahko za ocenjevanje konkurence uporabite Ranktrackerjev SERP Checker, ki vam bo pomagal utrditi šibke točke vaših konkurentov.

Preden izberete primarne in sekundarne ključne besede, se prepričajte, da jezik, o katerem pišete, ne zastareva ali se bistveno spreminja. Včasih se lahko zgodi, da boste našli popolno ključno besedo za pisanje jezikovnega vodnika, nato pa ugotovili, da se je ime jezika spremenilo, npr. Cairo je zdaj Cairo 1.0. Orodja, kot je Ahrefs, vam tega ne bodo takoj pokazala.

Če je jezik že bil spremenjen, bo to vidno. V nekaterih primerih pa je jezik morda še vedno v fazi predlaganja sprememb. Zato je zelo pomembno, da naredite obsežno domačo nalogo o tem, kaj jezik namerava storiti v prihodnje.

Nasvet št. 2 - Bodite zelo natančni glede osnutka vodnika

Pri pisanju obsežnih vodnikov o jezikih je osnova vse. Vendar pa je ustvarjanje osnutkov tudi ena od težjih nalog. Pri pisanju vodnikov za širše občinstvo morate upoštevati pravilo: ne smete biti preveč osnovni in tudi ne preveč tehnični. Vedno morate vzpostaviti ravnovesje med obema.

To pomeni, da bi morala tako začetnik kot strokovnjak razumeti in dojeti, kaj želite povedati. Pri tem vam je vaš oris v veliko pomoč. Zdaj je tu enako pomembno, da zadostite nameri iskalca in v skladu s tem pripravite vsebino.

Po mojih izkušnjah ljudje, ki iščejo vodnike o jezikih, običajno iščejo praktično znanje. Zato bi moral biti vaš oris bolj osredotočen na praktično učenje in manj na splošno znanje, kot je zgodovina programskega jezika.

(Slika prevzeta iz Sulekha)

Nasvet #3 - Vodnik začnite z manj zapletenimi stvarmi

Ko končno začnete pisati jezikovni priročnik, se prepričajte, da ste začeli z osnovnimi stvarmi in nato postopoma povečevali zahtevnost. Če pišete o jeziku, kot je Python, ga na začetku na kratko in jedrnato predstavite. Zapišite si vsa pomembna in zabavna dejstva o jeziku in jih začnite stresati na začetku. Da bi bralca pritegnili k blogu, je priporočljivo dodati statistične podatke, na primer kolikšen odstotek ljudi uporablja ta jezik itd. O tem lahko razmišljate tudi kot o odgovorih na vprašanja _kdo, kdaj, _in _čemu _jezika.

Nato morate navesti nekaj priljubljenih projektov, ki so bili kodirani v tem programskem jeziku. V mnogih primerih se ljudje ne zavedajo, da je aplikacija, ki jo vsakodnevno uporabljajo, delno ali v celoti kodirana v določenem programskem jeziku. Zato jih to zanima, so radovedni in nadaljujejo z branjem. Če v vodniku občasno omenimo ta zabavna dejstva, postane vodnik bolj sprejemljiv za manj izkušene programerje.

Razmislite lahko tudi o primerjavi med glavnim jezikom in njegovim konkurentom. To bo bralcu prineslo novo perspektivo. Na splošno poskusite prvih 500-600 besed nameniti predstavitvi jezika. Vendar ne prekoračite te meje.

Nasvet #4 - Večji poudarek namenite mesnatemu delu vodnika

Kot smo že omenili, ljudje, ki iščejo pisne vodnike na spletu, iščejo praktične nasvete in posebnosti jezika. Tudi pri branju dokumentacije programskega jezika boste opazili določen vzorec. Nekatere stvari so v vseh jezikih enake. To so podatkovne vrste, vrste spremenljivk, ogrodja, knjižnice, orodja itd.

To dokazuje, da teh posebnosti ni mogoče izpuščati in jih je treba vedno navesti. Čeprav ima vsak programski jezik več različnih ogrodij, knjižnic in orodij, morate za vsakega izbrati 3 priljubljene elemente in jih dodati. Pri tem so vam lahko v veliko pomoč uradni računi GitHub teh jezikov.

Morda se sprašujete, zakaj bi te podrobnosti dodajali v svoj vodnik, če so že objavljene v storitvi GitHub? No, informacije na GitHubu so ponavadi težke za navigacijo, saj je tam na stotine datotek. Zato vam bo osredotočanje na pomembne koščke zelo pomagalo, saj boste zapolnili vrzel tako, da boste bralcem hitro posredovali tri najboljše knjižnice, ogrodja, orodja itd. Poleg tega bodo bralci lahko iz vodnika potegnili tudi največ.

Nasvet #5 - Podvojite učni del

Ko začnete pisati glavni del vodnika, ki vključuje jezikovne posebnosti, morate poskrbeti, da bralcu zagotovite vrednost s praktično uporabo napisanega.

Večina vodnikov, ki so danes na voljo na spletu, ne vključuje kodiranja. Če prihajate iz netehničnega okolja, tudi ne poznate kodiranja. Vendar pa lahko z navedbo osnovnih korakov kodiranja v članku, zlasti z uporabo ogrodij in knjižnic ter orodij, ki ste jih omenili, vaš vodnik pridobi na vrednosti.

Toda kako lahko kodirate, če o tem ne veste ničesar? Tu vam lahko pomaga Bard, ChatGPT ali Ranktrackerjev AI Article Writer, ki vam v treh enostavnih korakih pomaga recimo kodirati najpreprostejšo pametno pogodbo. Lahko ga daš preveriti prijatelju ali znancu, ki se ukvarja s programiranjem, ali pa ga objaviš na forumu za programiranje, da se prepričaš, da je to, kar si napisal, pravilno.

To bo povečalo vašo avtentičnost in avtoriteto kot lastnika bloga ali pisca.

Zaključek,

Pisanje obsežnih tehničnih vodnikov ni lahka naloga, zlasti če nimate veliko znanja o programskem žargonu. Pri tem se boste srečevali z različnimi izzivi. Vendar pa boste, ko boste napisali prve 2-3 vodnike za programske jezike, stvari obvladali. To deluje kot proces. Čeprav zgoraj navedeni nasveti morda niso najbolj natančna formula za pisanje vodnikov o programskih jezikih, vam kot nekomu, ki ne pripada tehničnemu okolju, zagotovo lahko pomagajo uskladiti in dodati strukturo vašim vodnikom.