Hogyan írjunk a programozási nyelvekről technikai háttér nélkül?

Intro

Az írás mindig is szenvedélyem volt. Amikor Web3-írói állást kaptam egy oktatástechnikai cégnél, a felhőkön jártam. A Social Media Today szerint az internetezők 77%-a olvas blogokat. Így a munkám lehetőséget adott arra, hogy megismertessem a világgal a munkámat.

Miközben arról ábrándoztam, hogy a következő néhány hónapban hűséges közönségem és nemzetközi olvasótáborom lesz, a menedzserem megkért, hogy írjak útmutatókat a különböző programozási nyelvekről, amelyeket a Web3 térben nagymértékben használnak. Mivel nem műszaki háttérrel rendelkezem, ez nehéz feladatnak tűnt.

Sok próbálkozás és hiba után azonban végül elértem egy olyan pontra, ahol összeállítottam egy receptet a különböző programozási nyelvekről szóló hosszú útmutatók megírására, méghozzá úgy, hogy egy technikai háttérrel rendelkező személy írjon.

Ezért ebben a blogban öt olyan tippet fogok megosztani, amelyek energiát és időt takarítottak meg, és segítettek nekem olyan technikai és tényszerűen helyes útmutatókat írni, amelyek a Google-on rangsorolhatók.

(Kép: Metaschool)

Miért érdemes műszaki témájú útmutatókat írni?

Mielőtt ez az útmutató rátérne a képletre, először is értsük meg, miért fontos és miért hozhat jó eredményeket a blogja számára a technikai témájú útmutatók írása.

Először is, a technikai útmutatók nagyszerű lehetőséget nyújtanak arra, hogy kapcsolatot teremtsen a közönséggel, megossza tudását és készségeit. A műszaki tartalom azonban nagyon is hiánypótló. Nem valószínű, hogy ilyen útmutatókat írsz, ha életmódblogod van. Az új technológiai fejlesztések, például az AI és a blokklánc térnyerésével azonban a technikai témájú blogok egyre nagyobb teret nyernek. Sokan rendelkeznek saját AI-alapú termékekkel. Ez az a pont, ahol a technikai írás óriási szerepet játszhat abban, hogy a blogja és a terméke felé terelje a forgalmat.

Másodszor, nem kétséges, hogy napjainkban, amikor valami technikai dolgot akarsz megtanulni, a YouTube a legmegfelelőbb hely. Több százezer videó és oktatóanyag áll rendelkezésre. A tér eléggé telített, ha úgy tetszik. Most elgondolkodhat azon, hogy ha a szükséges anyag már elérhető a YouTube-on, miért akarna bárki is hosszadalmas útmutatók írásához folyamodni? Nos, itt a válasz. Mindenki körülötted többé-kevésbé ugyanígy gondolkodik. Az emberek arra koncentrálnak, hogy egyre több videós tartalmat készítsenek, és nem veszik észre, hogy írásos tartalmakkal is lehet közönséget építeni.

Harmadszor, ha a programozási nyelvekről beszélünk, akkor nem sok írott útmutató található az interneten. A hivatalos weboldalakon elérhető dokumentáció általában terjedelmes és sok információt tartalmaz. Az útmutatók lényegében egy nyelv hosszú dokumentációja által nyújtott összes rendelkezésre álló információt összevonják, összefoglalják, és egy kevésbé áttekinthető, könnyen navigálható változatot osztanak meg, hogy kiszolgálják az olvasni szerető közönséget.

Végül, hogy megismételjem, ha olyan vállalkozásod van, amely a technológia, a Web3 és az AI körül forog, az útmutatók írása a leggyorsabb módja annak, hogy segítsen a különböző kulcsszavakra való rangsorolásban és az üzleted előtérbe helyezésében. Ez néhány ok, amiért érdemes megfontolnia a technikai témájú útmutatók írását, ha blogja vagy vállalkozása van egy hasonló résen.

Tipp #1 - Válassza ki okosan a nyelveket, amelyeken az útmutatókat írni kívánja

Az első lépés az, hogy bölcsen kell eljárni, mert nem szeretnénk olyan nyelvről, például a Solidityről írni egy útmutatót, amelyre már így is nehéz rangsorolni. Ezért alapos kulcsszó-kutatással kell kezdenie, mielőtt elkezdene útmutatókat írni egy nyelvről. Az alacsony erőfeszítésű kulcsszavak varázsformulája a következő: nagy keresési volumen és alacsony nehézség. Ehhez kihasználhatja a Ranktracker kulcsszókeresőjét. Azt is ellenőrizheti, hogy hány teljes terjedelmű útmutatót adtak már ki, hogy képet kapjon a versenytársakról. Valójában a versenytársak felméréséhez használhatja a Ranktracker SERP Checkerét, amely segít konszolidálni a versenytársak gyenge pontjait.

Mielőtt azonban kiválasztaná az elsődleges és másodlagos kulcsszavakat, győződjön meg arról, hogy a nyelv, amelyen ír, nem elavul vagy nem megy keresztül nagyobb változásokon. Néha előfordulhat, hogy a nyelvi útmutató megírásához a tökéletes kulcsszót megtalálva csak azt veszi észre, hogy a nyelv neve megváltozott, azaz a Kairóból Kairó 1.0 lett. Az olyan eszközök, mint az Ahrefs, ezt nem fogják azonnal megmutatni.

Ha egy nyelv már átesett egy változáson, akkor azt látni fogja. Bizonyos esetekben azonban előfordulhat, hogy egy nyelv még a változtatási javaslatok benyújtásának szakaszában van. Ezért is szuper fontos, hogy alapos házi feladatot végezzünk arról, hogy egy nyelv mit tervez legközelebb.

Tipp #2 - Legyen nagyon pontos az útmutató vázlatával kapcsolatban

A vázlat minden, amikor hosszú nyelvi útmutatókat írunk. A vázlatok készítése azonban történetesen az egyik legnehezebb feladat is. Amikor szélesebb közönségnek szóló útmutatókat írsz, van egy ökölszabály, amit be kell tartanod: nem lehetsz túl egyszerű, és nem lehetsz túl technikai sem. Mindig egyensúlyt kell találnia a kettő között.

Ez azt jelenti, hogy egy kezdő programozónak és egy szakértőnek is képesnek kell lennie megérteni és felfogni a mondanivalódat. A vázlatod pedig nagyban segít ebben az esetben. Itt most ugyanolyan fontos, hogy megfeleljen a kereső szándékának, és ennek megfelelően állítsa elő a tartalmat.

Tapasztalatom szerint, amikor az emberek nyelvi útmutatókat keresnek, általában gyakorlati tudást keresnek. Ezért a vázlatának inkább a gyakorlati tanulásra kell összpontosítania, és kevésbé az általános ismeretekre, például a programozási nyelvek történetére.

(A kép a Sulekha oldalról származik)

Tipp #3 - Kezdje az útmutatót kevésbé összetett dolgokkal

Amikor végül elkezdi megírni a nyelvi útmutatóját, győződjön meg róla, hogy az alapokkal kezdi, majd a bonyolultságot a későbbiekben növeli. Ha egy olyan nyelvről írsz, mint a Python, már az elején mutasd be röviden és tömören. Jegyezd fel az összes fontos és szórakoztató tényt a nyelvvel kapcsolatban, és kezdd el szórni őket az elején. Annak érdekében, hogy az olvasót a blogra akassza, ajánlott olyan statisztikákat is hozzáadni, mint például, hogy hány százaléknyi ember használja ezt a nyelvet stb. Úgy is gondolhatsz rá, mint a _ki, mikor, _és _miért_ kérdés megválaszolására egy nyelvről.

Ezután meg kell említenie néhány népszerű projektet, amelyeket ezzel a programozási nyelvvel kódoltak. Sok esetben az emberek nem is tudják, hogy egy általuk napi szinten használt alkalmazás részben vagy teljesen egy bizonyos programozási nyelven van kódolva. Így ez kíváncsivá és kíváncsivá teszi őket, és tovább olvasnak. Sőt, ha az útmutatóban időnként megemlítjük ezeket a szórakoztató tényeket, az útmutatót a kevésbé tapasztalt programozók számára is élvezhetőbbé tesszük.

Azt is fontolóra veheti, hogy összehasonlítást végezzen a fő nyelv és a versenytársa között. Ez még inkább új perspektívát nyújt az olvasónak. Mindent egybevetve, az első 500-600 szót próbálja a nyelv bemutatására fordítani. De próbálja meg nem túllépni ezt a határt.

Tipp #4 - Fektessen nagy hangsúlyt az útmutató húsos részére

Mint említettük, az interneten írott útmutatókat kereső emberek gyakorlati tippeket és a nyelv sajátosságait keresik. A programozási nyelvek dokumentációjának olvasásakor is megfigyelhető egy minta. Néhány dolog mindegyikben állandó. Ezek közé tartoznak az adattípusok, a változótípusok, a keretrendszerek, a könyvtárak, az eszközök stb.

Ez azt mutatja, hogy ezekről a sajátosságokról nem lehet kompromisszumot kötni, és mindig meg kell említeni őket. Bár minden programozási nyelvnek számos különböző keretrendszere, könyvtára és eszköze van, azt kell tenned, hogy mindegyikhez kiválasztasz 3 népszerű elemet, és hozzáadod őket. A nyelvek hivatalos GitHub-fiókjai jelentős segítséget nyújthatnak ebben.

Most elgondolkodhatsz azon, hogy ha ezek a részletek már ott vannak a GitHubon, miért kellene hozzáadnod őket az útmutatódhoz? Nos, a GitHubon található információk általában nehezen navigálhatók, mivel több száz fájl van. Így a fontos részekre való összpontosítás nagyban segít, mivel hiánypótló lesz azzal, hogy gyorsan megadja az olvasóknak a 3 legfontosabb könyvtárat, keretrendszert, eszközt stb. Ráadásul az olvasók is a legtöbbet tudják majd kihozni az útmutatóból.

Tipp #5 - Duplázza meg a tanulási részt

Amikor elkezdte írni az útmutató fő részét, amely a nyelvi sajátosságokat tartalmazza, gondoskodnia kell arról, hogy a leírtak gyakorlati alkalmazásával értéket nyújtson az olvasónak.

Az interneten elérhető útmutatók többsége ma már nem tartalmaz kódolást. Ha nem műszaki háttérrel rendelkezel, akkor a kódolással sincs tisztában. Azonban az alapvető kódolási lépések megemlítése a cikkben, különösen az Ön által említett keretrendszerek és könyvtárak, valamint eszközök használatával, értékesebbé teheti az útmutatóját.

De hogyan tudsz kódolni, ha semmit sem tudsz róla? Itt kaphatsz segítséget a Bardtól, a ChatGPT-től vagy a Ranktracker AI cikkírójától, hogy segítsen neked, mondjuk a legegyszerűbb intelligens szerződés kódolásában, 3 egyszerű lépésben. Ellenőriztetheted egy kódoló barátoddal vagy ismerősöddel, vagy felteheted egy kódolói fórumra, hogy megbizonyosodj arról, hogy amit írtál, az helyes.

Ez növeli a hitelességet és a tekintélyt, mint blogtulajdonos vagy író.

Összefoglalva,

Hosszú technikai útmutatókat írni nem könnyű feladat, különösen akkor, ha nem ismeri a programozási szakzsargont. Különböző kihívások merülnek fel. Ha azonban egyszer megírta az első 2-3 programozási nyelvi útmutatót, akkor belejön a dolgokba. Ez egy folyamatként működik. Bár a fent említett tippek talán nem a legpontosabb képlet a programozási nyelvekről szóló útmutatók írásához, de biztosan segíthetnek összehangolni és strukturálni az útmutatókat, mint valaki, aki nem tartozik a műszaki háttérhez.