Ako písať o programovacích jazykoch bez technického vzdelania

Úvod

Písanie bolo vždy mojou vášňou. Keď som dostala prácu ako pisateľka pre web3 v spoločnosti zaoberajúcej sa vzdelávacími technológiami, bola som v siedmom nebi. Podľa Social Media Today 77 % používateľov internetu číta blogy. Moja práca mi teda poslúžila ako príležitosť predstaviť svetu svoju prácu.

Zatiaľ čo som sníval o tom, ako budem mať v najbližších mesiacoch verné publikum a medzinárodnú čitateľskú obec, môj manažér ma požiadal, aby som napísal príručky o rôznych programovacích jazykoch, ktoré sa vo veľkej miere používajú v oblasti Web3. Keďže pochádzam z netechnického prostredia, pripadalo mi to ako náročná úloha.

Po mnohých pokusoch a omyloch som však nakoniec dospel k tomu, že som si vytvoril recept na písanie dlhých príručiek o rôznych programovacích jazykoch, a to aj spôsobom, ktorý by napísal človek s technickým vzdelaním.

V tomto blogu sa teda podelím o päť tipov, ktoré mi ušetrili energiu a čas a pomohli mi napísať technické a vecne správne príručky, ktoré sa môžu umiestniť v Google.

(Obrázok od Metaschool)

Prečo by ste mali písať príručky o technických témach?

Predtým, ako tento návod prejde k vzorcu, najprv pochopíme, prečo je písanie návodov na technické témy dôležité a môže priniesť dobré výsledky pre váš blog.

Technické príručky slúžia predovšetkým ako skvelý spôsob, ako sa spojiť s publikom, podeliť sa o svoje vedomosti a zručnosti. Technický obsah je však tiež veľmi špecifický pre danú oblasť. Ak vlastníte lifestylový blog, pravdepodobne nebudete písať takéto príručky. Avšak s novými technologickými pokrokmi, ako je umelá inteligencia a blockchain, ktoré získavajú na popularite, zaznamenávajú blogy súvisiace s technikou nárast. Mnohé z nich majú vlastné produkty podporujúce umelú inteligenciu. Práve tu môže technické písanie zohrávať veľkú úlohu pri zvyšovaní návštevnosti smerom k vášmu blogu a produktu.

Po druhé, niet pochýb o tom, že v dnešnej dobe, keď sa chcete naučiť niečo technické, je YouTube miestom, kam sa môžete obrátiť. K dispozícii sú státisíce videí a návodov. Tento priestor je celkom nasýtený, ak chcete. Možno sa teraz pýtate, že ak je už požadovaný materiál k dispozícii na YouTube, prečo by sa niekto mal uchyľovať k písaniu dlhých návodov? Nuž, práve tu je vaša odpoveď. Všetci okolo vás viac-menej rozmýšľajú rovnako. Ľudia sa zameriavajú na tvorbu čoraz väčšieho množstva videoobsahu a neuvedomujú si, že publikum si môžu vybudovať aj písaním obsahu.

Po tretie, ak hovoríme o programovacích jazykoch, na internete nie je veľa písomných príručiek. Dokumentácia dostupná na oficiálnych webových stránkach býva obsiahla a obsahuje veľa informácií. Sprievodcovia v podstate konsolidujú všetky dostupné informácie, ktoré poskytuje dlhá dokumentácia jazyka, zhrnú ich a zdieľajú menej prehľadnú a ľahko orientovateľnú verziu, aby uspokojili publikum, ktoré radšej číta.

Na záver zopakujme, že ak máte podnikanie, ktoré sa točí okolo technológií, Web3 a AI, písanie príručiek je najrýchlejší spôsob, ako vám pomôcť zaradiť sa na rôzne kľúčové slová a dostať vaše podnikanie do popredia. Toto sú niektoré z dôvodov, prečo by ste mali zvážiť písanie príručiek na technické témy, ak máte blog alebo podnikáte v podobnom výklenku.

Tip č. 1 - Vyberte si rozumne jazyky, v ktorých chcete písať príručky

Prvým krokom je postupovať rozumne, pretože by ste nechceli písať príručku o jazyku, ako je Solidity, ktorý sa už ťažko zaraďuje. Preto by ste mali začať s dôkladným prieskumom kľúčových slov skôr, ako začnete písať príručky o danom jazyku. Magický vzorec pre kľúčové slová s nízkou náročnosťou je; vysoký objem vyhľadávania a nízka náročnosť. Môžete na to využiť vyhľadávač kľúčových slov spoločnosti Ranktracker. Môžete tiež skontrolovať počet už uverejnených plnohodnotných sprievodcov, aby ste získali predstavu o svojich konkurentoch. V skutočnosti môžete na posúdenie svojich konkurentov použiť nástroj SERP Checker nástroja Ranktracker, ktorý vám pomôže skonsolidovať slabé miesta vašich konkurentov.

Pred výberom primárnych a sekundárnych kľúčových slov sa však uistite, že jazyk, o ktorom píšete, nezastaráva alebo neprechádza žiadnymi významnými zmenami. Niekedy sa môže stať, že nakoniec nájdete dokonalé kľúčové slovo, na ktoré chcete napísať svoju jazykovú príručku, len aby ste si uvedomili, že názov jazyka sa zmenil, t. j. Káhira je teraz Káhira 1.0. Nástroje ako Ahrefs vám to okamžite neukážu.

Ak už v jazyku prebehla zmena, uvidíte ju. V niektorých prípadoch však môže byť jazyk ešte len v štádiu navrhovania zmien. Aj preto je mimoriadne dôležité urobiť si rozsiahlu domácu úlohu o tom, čo jazyk plánuje ďalej.

Tip č. 2 - Buďte veľmi konkrétni, pokiaľ ide o osnovu príručky

Pri písaní dlhých príručiek o jazykoch je osnova všetkým. Vytváranie osnov však býva aj jednou z najťažších úloh. Pri písaní príručiek pre širšie publikum musíte dodržiavať jedno pravidlo: nemôžete byť príliš základný a nemôžete byť ani príliš technický. Vždy musíte nájsť rovnováhu medzi oboma.

To znamená, že programátor začiatočník aj odborník by mal byť schopný pochopiť a porozumieť tomu, čo chcete povedať. A vaša osnova vám v tomto prípade výrazne pomáha. Teraz je tu rovnako dôležité splniť zámer vyhľadávača a podľa toho vytvoriť obsah.

Podľa mojich skúseností, keď ľudia hľadajú príručky o jazykoch, zvyčajne hľadajú praktické znalosti. Preto by sa vaša osnova mala viac zameriavať na praktické učenie a menej na všeobecné znalosti, ako je napríklad história programovacieho jazyka.

(Obrázok prevzatý z Sulekha)

Tip č. 3 - Začnite sprievodcu menej zložitými vecami

Keď konečne začnete písať jazykovú príručku, nezabudnite začať so základnými vecami a potom postupne zvyšovať zložitosť. Ak píšete o jazyku, ako je Python, stručne a výstižne ho predstavte hneď na začiatku. Poznačte si všetky dôležité a zábavné fakty o jazyku a začnite ich sypať na začiatku. Aby ste čitateľa na blogu upútali, odporúčame pridať štatistiky, napríklad aké percento ľudí používa tento jazyk atď. Môžete o tom uvažovať aj ako o odpovedi na otázky _kto, kedy, _a _prečo _jazyk používa.

Potom musíte spomenúť niektoré z populárnych projektov, ktoré boli napísané pomocou tohto konkrétneho programovacieho jazyka. V mnohých prípadoch si ľudia neuvedomujú, že aplikácia, ktorú denne používajú, je čiastočne alebo úplne nakódovaná v určitom programovacom jazyku. To v nich vyvoláva záujem a zvedavosť a pokračujú v čítaní. Občasné spomenutie týchto zábavných faktov v rámci príručky v skutočnosti robí príručku prijateľnejšou pre menej skúsených programátorov.

Môžete tiež zvážiť porovnanie hlavného jazyka s jeho konkurentom. To čitateľovi prinesie nový pohľad na vec. Celkovo sa snažte prvých 500-600 slov venovať predstaveniu jazyka. Snažte sa však neprekročiť tento limit.

Tip č. 4 - Zamerajte sa na mäsitú časť sprievodcu

Ako už bolo spomenuté, ľudia, ktorí hľadajú písomné príručky online, hľadajú praktické tipy a špecifiká jazyka. Pri čítaní dokumentácie programovacieho jazyka si tiež všimnete určitý vzor. Niektoré veci sú vo všetkých konštantné. Patria k nim dátové typy, typy premenných, rámce, knižnice, nástroje atď.

To dokazuje, že tieto špecifiká nemôžu byť predmetom kompromisov a mali by byť vždy uvedené. Aj keď každý programovací jazyk má množstvo rôznych rámcov, knižníc a nástrojov, to, čo by ste mali urobiť, je vybrať 3 populárne prvky pre každý z nich a pridať ich. V tomto smere vám môžu výrazne pomôcť oficiálne účty jazykov na GitHube.

Možno sa teraz pýtate, že ak sú tieto údaje už na GitHube, prečo by ste ich mali pridávať do svojej príručky? No, informácie na GitHube bývajú náročné na orientáciu, pretože sú tam stovky súborov. Zameranie sa na dôležité kúsky teda výrazne pomôže, pretože vyplníte medzeru tým, že čitateľom rýchlo poskytnete 3 najlepšie knižnice, frameworky, nástroje atď. Okrem toho budú môcť čitatelia zo sprievodcu vyťažiť maximum.

Tip č. 5 - Zdvojnásobte úsilie pri učení

Keď ste začali písať hlavnú časť príručky, ktorá obsahuje jazykové špecifiká, mali by ste zabezpečiť, aby ste čitateľovi poskytli hodnotu praktickým uplatnením toho, čo ste napísali.

Väčšina príručiek dostupných na internete dnes neobsahuje kódovanie. Ak pochádzate z netechnického prostredia, o kódovaní tiež nebudete mať potuchy. Avšak uvedenie základných krokov kódovania v rámci článku, najmä pomocou rámcov a knižníc a nástrojov, ktoré ste spomenuli, môže zvýšiť hodnotu vašej príručky.

Ale ako môžete kódovať, keď o tom nič neviete? Tu vám môže pomôcť Bard alebo ChatGPT alebo AI Article Writer spoločnosti Ranktracker, ktorý vám pomôže, povedzme, nakódovať najjednoduchší inteligentný kontrakt v 3 jednoduchých krokoch. Môžete ho dať skontrolovať kamarátovi alebo známemu programátorovi alebo ho zverejniť na programátorskom fóre, aby ste sa uistili, že to, čo ste napísali, je správne.

To zvýši vašu autenticitu a autoritu ako majiteľa blogu alebo spisovateľa.

Na záver,

Písanie dlhých technických príručiek nie je jednoduchá úloha, najmä ak nemáte veľa znalostí o programovacom žargóne. Čakajú vás rôzne výzvy. Keď však napíšete svoje prvé 2-3 príručky o programovacom jazyku, veci sa vám podarí zvládnuť. Funguje to ako proces. Hoci uvedené tipy nemusia byť najpresnejším receptom na písanie príručiek o programovacích jazykoch, určite vám ako niekomu, kto nepatrí k technickému vzdelaniu, pomôžu zladiť a dodať štruktúru vašim príručkám.