Jak psát o programovacích jazycích bez technického vzdělání

Úvodní stránka

Psaní bylo vždy mou vášní. Když jsem dostala práci jako spisovatelka pro web3 v jedné společnosti zabývající se vzdělávacími technologiemi, byla jsem v sedmém nebi. Podle Social Media Today čte blogy 77 % uživatelů internetu. Moje práce mi tedy posloužila jako příležitost seznámit svět se svou prací.

Zatímco jsem snil o tom, jak budu mít za pár měsíců věrné publikum a mezinárodní čtenářskou obec, požádal mě můj manažer, abych napsal průvodce různými programovacími jazyky, které se v oblasti Web3 hojně používají. Protože pocházím z netechnického prostředí, připadalo mi to jako obtížný úkol.

Po mnoha pokusech a omylech jsem však nakonec dospěl k tomu, že jsem si vytvořil recept na psaní dlouhých příruček o různých programovacích jazycích, a to způsobem, který by napsal člověk s technickým vzděláním.

V tomto blogu se tedy podělím o pět tipů, které mi ušetřily energii a čas a pomohly mi napsat technické a věcně správné průvodce, které se mohou umístit na Googlu.

(Obrázek od Metaschool)

Proč byste měli psát průvodce na technická témata?

Než tento průvodce přejde k formulaci, pojďme nejprve pochopit, proč je psaní návodů na technická témata důležité a může přinést dobré výsledky pro váš blog.

Technické příručky slouží především jako skvělý způsob, jak navázat kontakt s publikem, podělit se o své znalosti a dovednosti. Technický obsah je však také velmi specifický pro určitou niku. Pokud vlastníte lifestylový blog, pravděpodobně takové průvodce psát nebudete. Nicméně s tím, jak se prosazují nové technologické vymoženosti, jako je umělá inteligence a blockchain, zaznamenávají blogy zaměřené na techniku vzestup. Mnohé z nich mají vlastní produkty podporované umělou inteligencí. Právě zde může technické psaní hrát velkou roli při zvyšování návštěvnosti směrem k vašemu blogu a produktu.

Za druhé, není pochyb o tom, že v dnešní době, kdy se chcete naučit něco technického, je YouTube místem, kam se můžete obrátit. Jsou zde k dispozici statisíce videí a výukových programů. Tento prostor je docela nasycený, chcete-li. Možná si teď říkáte, že když už je potřebný materiál k dispozici na YouTube, proč by se někdo měl uchylovat k psaní dlouhých návodů? No, to je právě vaše odpověď. Všichni kolem vás uvažují víceméně stejně. Lidé se zaměřují na vytváření stále většího množství videoobsahu a neuvědomují si, že publikum si mohou vybudovat i psaním obsahu.

Za třetí, pokud mluvíme o programovacích jazycích, pak na internetu není mnoho písemných návodů. Dokumentace dostupná na oficiálních webových stránkách bývá heslovitá a obsahuje mnoho informací. Průvodci v podstatě konsolidují všechny dostupné informace, které poskytuje obsáhlá dokumentace jazyka, shrnují je a sdílejí méně přehlednou a snadno ovladatelnou verzi, aby uspokojili publikum, které dává přednost čtení.

A nakonec, abychom zopakovali, že pokud máte firmu, která se točí kolem technologií, Web3 a AI, je psaní průvodců nejrychlejší způsob, jak vám pomoci zařadit se na různá klíčová slova a dostat svou firmu do popředí. To jsou některé z důvodů, proč byste měli zvážit psaní návodů na technická témata, pokud máte blog nebo podnikáte v podobném oboru.

Tip č. 1 - Vyberte si rozumně jazyky, ve kterých chcete psát své průvodce.

Prvním krokem je postupovat uvážlivě, protože byste nechtěli psát příručku o jazyce, jako je Solidity, který se již obtížně umísťuje. Proto byste měli začít důkladným průzkumem klíčových slov, než začnete psát průvodce o daném jazyce. Kouzelný vzorec pro klíčová slova s nízkou náročností je: vysoký objem vyhledávání a nízká obtížnost. K tomu můžete využít vyhledávač klíčových slov společnosti Ranktracker. Můžete také zkontrolovat počet již publikovaných plnohodnotných průvodců, abyste získali představu o svých konkurentech. Ve skutečnosti můžete k posouzení svých konkurentů využít nástroj SERP Checker nástroje Ranktracker, který vám pomůže konsolidovat slabá místa vašich konkurentů.

Než si však vyberete primární a sekundární klíčová slova, ujistěte se, že jazyk, o kterém píšete, nezastarává nebo neprochází zásadními změnami. Někdy se může stát, že nakonec najdete perfektní klíčové slovo, na které chcete napsat jazykového průvodce, jen abyste zjistili, že se název jazyka změnil, tj. z Káhiry je nyní Cairo 1.0. Nástroje jako Ahrefs vám to okamžitě neukážou.

Pokud již v jazyce došlo ke změně, zobrazí se vám. V některých případech však může být jazyk stále ve fázi návrhu změn. Proto je také mimořádně důležité udělat si rozsáhlý domácí úkol o tom, co jazyk zamýšlí udělat příště.

Tip č. 2 - Buďte velmi konkrétní ohledně osnovy průvodce

Při psaní dlouhých jazykových příruček je osnova vším. Vytvoření osnovy je však také jedním z nejobtížnějších úkolů. Při psaní příruček pro širší publikum je třeba dodržovat jedno pravidlo: nesmíte být příliš základní a nesmíte být ani příliš technicistní. Vždy musíte najít rovnováhu mezi obojím.

To znamená, že jak začínající programátor, tak i odborník by měl být schopen pochopit a porozumět tomu, co chcete říci. A vaše osnova vám v tomto případě výrazně pomůže. Nyní je zde stejně důležité splnit záměr vyhledávače a podle toho vytvořit obsah.

Podle mých zkušeností, když lidé hledají příručky o jazycích, obvykle hledají praktické znalosti. Proto by se vaše osnova měla více zaměřit na praktické učení a méně na obecné znalosti, jako je historie programovacího jazyka.

(Obrázek převzat z webu Sulekha)

Tip č. 3 - Začněte průvodce méně složitými věcmi

Až konečně začnete psát jazykovou příručku, nezapomeňte začít se základními věcmi a pak postupně zvyšovat složitost. Pokud píšete o jazyce, jako je Python, stručně a výstižně jej představte hned na začátku. Zapište si všechna důležitá a zábavná fakta o jazyce a začněte je sypat hned na začátku. Abyste čtenáře na blogu upoutali, doporučujeme přidat statistiky typu kolik procent lidí tento jazyk používá apod. Můžete o tom také přemýšlet jako o odpovědi na otázky _kdo, kdy, _a _proč _jazyk.

Pak je třeba zmínit některé z populárních projektů, které byly napsány právě v tomto programovacím jazyce. V mnoha případech si lidé neuvědomují, že aplikace, kterou denně používají, je částečně nebo zcela nakódována v určitém programovacím jazyce. To v nich tedy vyvolává zájem a zvědavost a pokračují ve čtení. Občasná zmínka o těchto zábavných faktech v příručce totiž činí příručku přijatelnější i pro méně zkušené programátory.

Můžete také zvážit srovnání hlavního jazyka s jeho konkurentem. To čtenáři dále přinese nový pohled na věc. Celkově se snažte prvních 500-600 slov věnovat představení jazyka. Snažte se však tento limit nepřekračovat.

Tip č. 4 - Věnujte dostatečnou pozornost hlavní části průvodce

Jak již bylo zmíněno, lidé, kteří hledají písemné průvodce online, hledají praktické tipy a specifika jazyka. Při čtení dokumentace k programovacímu jazyku si také všimnete určitého vzoru. Některé věci jsou napříč všemi konstantní. Patří mezi ně datové typy, typy proměnných, rámce, knihovny, nástroje atd.

Z toho vyplývá, že tyto specifické aspekty nelze opomíjet a měly by být vždy uvedeny. Každý programovací jazyk má sice řadu různých frameworků, knihoven a nástrojů, ale pro každý z nich byste měli vybrat 3 oblíbené prvky a přidat je. V tomto ohledu vám mohou výrazně pomoci oficiální účty jazyků na GitHubu.

Možná si teď říkáte, že když už tyto údaje na GitHubu jsou, proč byste je měli přidávat do své příručky? No, informace na GitHubu bývají složité na orientaci, protože tam jsou stovky souborů. Zaměření se na důležité kousky tedy výrazně pomůže, protože vyplníte mezeru tím, že čtenářům rychle poskytnete 3 nejlepší knihovny, frameworky, nástroje atd. Navíc čtenáři budou moci z příručky vytěžit maximum.

Tip č. 5 - Zdvojnásobte úsilí při učení

Když jste začali psát hlavní část příručky, která obsahuje jazyková specifika, měli byste se ujistit, že čtenáři poskytnete hodnotu tím, že prakticky použijete to, co jste napsali.

Většina průvodců dostupných na internetu dnes neobsahuje kódování. Pokud pocházíte z netechnického prostředí, nemáte o kódování ani ponětí. Zmíněním základních kroků kódování v rámci článku, zejména s využitím vámi uvedených frameworků a knihoven a nástrojů, však může váš průvodce získat na hodnotě.

Ale jak můžete kódovat, když o tom nic nevíte? Tady vám může pomoci Bard nebo ChatGPT nebo AI Article Writer společnosti Ranktracker, kteří vám pomohou, řekněme, nakódovat nejjednodušší inteligentní smlouvu, a to ve 3 snadných krocích. Můžete si ho nechat zkontrolovat od kamaráda nebo známého kodéra nebo ho zveřejnit na kodérském fóru, abyste se ujistili, že to, co jste napsali, je správně.

To přispěje k vaší autenticitě a autoritě jako majitele blogu nebo spisovatele.

Závěrem,

Psaní dlouhých technických příruček není snadný úkol, zvláště když nemáte mnoho znalostí o programátorském žargonu. Čeká vás řada výzev. Jakmile však napíšete první 2-3 průvodce programovacím jazykem, dostanete se do pohody. Funguje to jako proces. Výše uvedené tipy sice nejsou tím nejpřesnějším receptem na psaní průvodců programovacími jazyky, ale určitě vám jako někomu, kdo nepatří k technickému vzdělání, pomohou průvodce sladit a dodat jim strukturu.