Kuidas kirjutada programmeerimiskeeltest ilma tehnilise taustata

Intro

Kirjutamine on alati olnud minu kirg. Kui ma sain tööd Web3-kirjutajana ühes haridustehnoloogiaga tegelevas ettevõttes, olin lausa pilve peal. Social Media Today andmetel loeb 77% internetikasutajatest blogisid. Seega oli minu töö võimalus tutvustada maailmale oma tööd.

Samal ajal, kui ma unistasin sellest, kuidas mul on paari kuu jooksul lojaalne publik ja rahvusvaheline lugejaskond, palus mu juht mul kirjutada juhendeid erinevate programmeerimiskeelte kohta, mida Web3-ruumis palju kasutatakse. Kuna ma ei ole tehnilise taustaga, tundus see raske ülesanne.

Kuid pärast palju katsetusi ja eksimusi jõudsin lõpuks punkti, kus olin koostanud retsepti pikkade juhendite kirjutamiseks erinevate programmeerimiskeelte kohta, ja seda ka nii, et tehnikaharidusega inimene kirjutaks.

Nii et selles blogis jagan viis nõuannet, mis säästsid minu energiat ja aega ning aitasid mul kirjutada tehniliselt ja faktiliselt korrektseid juhendeid, mis suudavad Google'is järjestatud olla.

(Pilt: Metaschool)

Miks peaksite kirjutama tehnilistel teemadel juhendeid?

Enne kui see juhend hüppab valemile, mõistame kõigepealt, miks tehniliste teemade kohta juhendite kirjutamine on oluline ja võib teie blogi jaoks häid tulemusi anda.

Kõigepealt on tehnilised juhendid suurepärane viis, kuidas luua kontakti publikuga, jagada oma teadmisi ja oskusi. Kuid tehniline sisu on ka väga nišispetsiifiline. Kui teil on elustiiliblogi, siis te tõenäoliselt selliseid juhendeid ei kirjuta. Kuid uute tehnoloogiliste edusammude, näiteks tehisintellekti ja plokiahela levikuga on tehnikaga seotud blogid tõusuteel. Paljudel on oma tehisintellektipõhised tooted. See on koht, kus tehniline kirjutamine võib mängida suurt rolli liikluse suunamisel teie blogi ja toote poole.

Teiseks ei ole kahtlust, et tänapäeval, kui soovite midagi tehnilist õppida, on YouTube'i kasutamine teie jaoks parim koht. Seal on saadaval sadu tuhandeid videoid ja õpetusi. Ruum on üsna küllastunud, kui soovite. Te võite nüüd küsida, et kui vajalik materjal on juba YouTube'is olemas, miks peaks keegi tahtma pöörduda pikkade juhendite kirjutamise poole? Noh, see on teie vastus just seal. Kõik teie ümber mõtlevad enam-vähem samamoodi. Inimesed keskenduvad üha enam videosisu tegemisele, mõistmata, et publikut saab luua ka sisu kirjutades.

Kolmandaks, kui me räägime programmeerimiskeeltest, siis ei ole internetis palju kirjalikke juhendeid. Ametlikel veebilehtedel olev dokumentatsioon kipub olema sõnarikas ja sisaldab palju teavet. Juhendid koondavad sisuliselt kogu olemasoleva teabe, mida keele pikk dokumentatsioon pakub, võtavad selle kokku ja jagavad vähem segadust tekitava, kergesti navigeeritava versiooni, et rahuldada publikut, kes eelistab lugeda.

Lõpetuseks, et korrata, kui teil on ettevõte, mis keerleb tehnoloogia, Web3 ja AI ümber, on juhendite kirjutamine kiireim viis, mis aitab teil erinevate märksõnade jaoks paremusjärjestusse jõuda ja teie ettevõtte esiplaanile tuua. Need on mõned põhjused, miks te peaksite kaaluma tehniliste teemade kohta juhendite kirjutamist, kui teil on blogi või ettevõte sarnases niššis.

Vihje #1 - valige targalt keeled, milles soovite oma juhendeid kirjutada

Esimene samm on astuda targalt, sest te ei taha kirjutada juhendit keele kohta, nagu näiteks Solidity, mille puhul on juba praegu raske järjestada. Seega peaksite alustama põhjaliku märksõnade uurimisega, enne kui hakkate kirjutama keele kohta juhendeid. Madala töömahuga märksõnade võluvormel on; suur otsingumaht ja madal raskusaste. Selleks saate kasutada Ranktracker'i märksõnafondi. Samuti võite kontrollida juba avaldatud täispikkuses juhendite arvu, et saada aimu oma konkurentidest. Tegelikult võite oma konkurentide hindamiseks kasutada Ranktracker'i SERP Checker 'i, mis aitab teil konsolideerida oma konkurentide nõrgad kohad.

Enne kui olete valinud oma esmased ja teiseseid märksõnu, veenduge siiski, et keel, millest te kirjutate, ei ole vananemas või läbimas suuri muutusi. Mõnikord võib juhtuda, et leiate ideaalse märksõna, mille kohta oma keelejuhend kirjutada, kuid märkate, et keele nimi on muutunud, nt Kairo on nüüd Kairo 1.0. Sellised tööriistad nagu Ahrefs ei näita seda kohe.

Kui keel on juba muutunud, näete seda. Kuid mõnel juhul võib keel olla alles muutuste kavandamise etapis. Seepärast on väga oluline teha põhjalik kodutöö selle kohta, mida keel kavatseb järgmiseks teha.

Näpunäide #2 - Ole väga konkreetne juhendi kontuuri osas

Pikkade keelejuhendite kirjutamisel on kontuur kõik, mis on oluline. Kuid kontuuride koostamine on ka üks raskemaid ülesandeid. Kui kirjutate juhendeid laiemale publikule, tuleb järgida ühte rusikareeglit: te ei tohi olla liiga lihtne ega ka liiga tehniline. Te peate alati leidma tasakaalu mõlema vahel.

See tähendab, et nii algaja programmeerija kui ka ekspert peaks olema võimeline aru saama ja mõistma, mida sa räägid. Ja teie ülevaade aitab teid sel juhul suuresti. Nüüd on siin võrdselt oluline vastata otsija kavatsusele ja toota sisu vastavalt sellele.

Minu kogemuse kohaselt otsivad inimesed, kui nad otsivad keelejuhendeid, tavaliselt praktilisi teadmisi. Seega peaks teie ülevaade keskenduma rohkem praktilisele õppimisele ja vähem üldistele teadmistele, näiteks programmeerimiskeele ajaloole.

(Pilt võetud Sulekha'st)

Vihje #3 - Alusta juhendit vähem keeruliste asjadega

Kui lõpuks hakkate oma keelejuhendit kirjutama, alustage kindlasti põhilistest asjadest ja suurendage siis keerukust, kui liigute edasi. Kui kirjutate mõnest keelest, näiteks Pythonist, tutvustage seda lühidalt ja lühidalt kohe alguses. Pange kirja kõik olulised ja lõbusad faktid keele kohta ja hakake neid alguses puistama. Selleks, et lugejat blogi külge haakida, on soovitatav lisada statistikat, näiteks kui palju inimesi seda keelt kasutab jne. Võite mõelda ka sellele, et vastate _kelle, millal, _ja _miks_ keelele.

Seejärel peate mainima mõningaid populaarseid projekte, mis on kodeeritud selle konkreetse programmeerimiskeele abil. Paljudel juhtudel ei ole inimesed teadlikud, et rakendus, mida nad igapäevaselt kasutavad, on osaliselt või täielikult kodeeritud teatavas programmeerimiskeeles. Seega teeb see neid intrigeerituks ja uudishimulikuks ning nad jätkavad lugemist. Tegelikult muudab nende lõbusate faktide aeg-ajalt mainimine juhendis juhendi ka vähem kogenud programmeerijatele vastuvõetavamaks.

Võite kaaluda ka võrdlust põhikeele ja selle konkurendi vahel. See annab lugejale veelgi uue vaatenurga. Kokkuvõttes püüdke esimesed 500-600 sõna kulutada keele tutvustamisele. Kuid püüdke mitte ületada seda piiri.

Näpunäide #4 - Pane rohkesti rõhku juhendi lihakale osale

Nagu mainitud, otsivad inimesed, kes otsivad kirjalikke juhendeid internetis, praktilisi näpunäiteid ja keele spetsiifikat. Ka programmeerimiskeele dokumentatsiooni lugedes näete mustrit. Mõned asjad on kõigis neist konstantsed. Nende hulka kuuluvad andmetüübid, muutujatüübid, raamistikud, raamatukogud, tööriistad jne.

See näitab, et nende eripäradega ei saa teha kompromisse ja neid tuleks alati mainida. Kuigi igas programmeerimiskeeles on mitmeid erinevaid raamistikke, raamatukogusid ja tööriistu, tuleks valida iga keele jaoks 3 populaarset elementi ja lisada need. Keelte ametlikud GitHubi kontod võivad teid selles osas oluliselt aidata.

Nüüd võite küsida, et kui need andmed on juba GitHubis olemas, siis miks peaksite need oma juhendile lisama? Noh, GitHubis olevas teabes kipub olema raske navigeerida, sest seal on sadu faile. Seega aitab keskendumine olulistele pisiasjadele suuresti, kuna täidate lünga, pakkudes lugejatele kiiresti 3 parimat raamatukogu, raamistikku, tööriista jne. Lisaks saavad lugejad ka juhisest kõige rohkem kasu.

Näpunäide #5 - kahekordistage õppimise osa

Kui olete hakanud kirjutama juhendi põhiosa, mis sisaldab keele spetsiifikat, peaksite tagama, et pakute lugejale väärtust, rakendades praktiliselt seda, mida olete kirjutanud.

Enamik tänapäeval internetis kättesaadavaid juhendeid ei sisalda kodeerimist. Kuna te ei ole tehnikast pärit, ei ole te ka kodeerimisest teadlikud. Siiski võib teie juhendi väärtuslikumaks muuta see, kui te mainite artiklis põhilisi kodeerimisetappe, eelkõige mainitud raamistike ja raamatukogude ning tööriistade kasutamist.

Aga kuidas sa koodid, kui sa ei tea sellest midagi? Siinkohal saate abi Bardilt või ChatGPT-lt või Ranktracker'i AI artikli kirjutajalt, et aidata teil, ütleme, kodeerida kõige lihtsam nutikas leping, 3 lihtsa sammuga. Sa võid lasta seda kontrollida kodeerija sõbral või tuttaval või postitada selle kodeerija foorumisse, et veenduda, et see, mida sa oled kirjutanud, on õige.

See suurendab teie kui blogi omaniku või kirjaniku autentsust ja autoriteeti.

Kokkuvõttes,

Pikkade tehniliste juhendite kirjutamine ei ole lihtne ülesanne, eriti kui teil ei ole palju teadmisi programmeerimisjargonist. Tekivad mitmesugused väljakutsed. Kuid kui olete kirjutanud esimesed 2-3 programmeerimiskeele juhendit, saate asjadest aru. See toimib kui protsess. Kuigi eespool nimetatud nõuanded ei pruugi olla kõige täpsem valem programmeerimiskeele juhendite kirjutamiseks, aitavad need kindlasti aidata teil oma juhendeid ühtlustada ja lisada neile struktuuri, kui keegi, kes ei kuulu tehnilisele taustale.