Kaip rašyti apie programavimo kalbas neturint techninio išsilavinimo

Įvadas

Rašymas visada buvo mano aistra. Kai gavau Web3 rašytojos darbą edukacinių technologijų bendrovėje, buvau kaip ant mielių. Socialinė žiniasklaida šiandien teigia, kad 77 % interneto vartotojų skaito tinklaraščius. Taigi, mano darbas tapo galimybe supažindinti pasaulį su savo darbu.

Kol svajojau apie tai, kaip per porą mėnesių turėsiu ištikimą auditoriją ir tarptautinę skaitytojų auditoriją, mano vadovas paprašė manęs parašyti vadovus apie įvairias programavimo kalbas, kurios plačiai naudojamos "Web3" erdvėje. Kadangi esu ne iš techninės srities, man tai atrodė sunki užduotis.

Tačiau po ilgų bandymų ir klaidų galiausiai pasiekiau tašką, kuriame sukūriau receptą, kaip rašyti ilgus vadovus apie įvairias programavimo kalbas, ir dar taip, kaip rašytų techninio išsilavinimo žmogus.

Taigi, šiame tinklaraštyje dalinuosi penkiais patarimais, kurie sutaupė mano energijos ir laiko bei padėjo man parašyti techninius ir faktiškai teisingus vadovus, kurie gali būti reitinguojami "Google".

(Paveikslėlio autorius - "Metaschool")

Kodėl turėtumėte rašyti vadovus techninėmis temomis?

Prieš pradedant šį vadovą, pirmiausia supraskime, kodėl rašyti vadovus techninėmis temomis yra svarbu ir gali duoti gerų rezultatų jūsų tinklaraščiui.

Pirmiausia techniniai vadovai yra puikus būdas užmegzti ryšį su auditorija, pasidalyti savo žiniomis ir įgūdžiais. Tačiau techninis turinys taip pat yra labai specifinis. Vargu ar rašysite tokius vadovus, jei turite gyvenimo būdo tinklaraštį. Tačiau, populiarėjant naujiems technologiniams pasiekimams, tokiems kaip dirbtinis intelektas ir blokų grandinė, su technologijomis susijusių tinklaraščių populiarumas auga. Daugelis jų turi savo produktus, paremtus dirbtiniu intelektu. Čia techninis rašymas gali atlikti didžiulį vaidmenį skatinant srautą į jūsų tinklaraštį ir produktą.

Antra, neabejotina, kad šiandien, kai norite išmokti ką nors techninio, "YouTube" yra jūsų geriausia vieta. Čia galima rasti šimtus tūkstančių vaizdo įrašų ir pamokų. Jei norite, ši erdvė yra gana prisotinta. Dabar jums gali kilti klausimas, kad jei reikiamą medžiagą jau galima rasti "YouTube", kodėl kas nors norėtų griebtis ilgų vadovų rašymo? Na, štai čia ir yra jūsų atsakymas. Visi aplink jus daugiau ar mažiau galvoja taip pat. Žmonės daugiausia dėmesio skiria vis daugiau vaizdo įrašų turinio kūrimui, nesuprasdami, kad auditoriją galima kurti ir rašant turinį.

Trečia, jei kalbame apie programavimo kalbas, internete nėra daug rašytinių vadovų. Oficialiose svetainėse esantys dokumentai paprastai būna daugžodžiai ir juose pateikiama daug informacijos. Vadovai iš esmės sujungia visą turimą informaciją, pateiktą ilgoje kalbos dokumentacijoje, ją apibendrina ir pateikia ne tokią gremėzdišką, lengvai perprantamą versiją, skirtą auditorijai, kuri mieliau skaito.

Galiausiai, norėdami pakartoti, jei turite verslą, kuris sukasi apie technologijas, Web3 ir dirbtinį intelektą, vadovų rašymas yra greičiausias būdas padėti jums reitinguoti įvairius raktinius žodžius ir iškelti savo verslą į pirmą vietą. Tai keletas priežasčių, kodėl turėtumėte apsvarstyti galimybę rašyti vadovus techninėmis temomis, jei turite tinklaraštį arba verslą panašioje nišoje.

Patarimas Nr. 1 - Išmintingai pasirinkite kalbas, kuriomis norite rašyti vadovus

Pirmasis žingsnis - elgtis protingai, nes nenorėtumėte rašyti vadovo apie kalbą, pavyzdžiui, "Solidity", kurią ir taip sunku reitinguoti. Taigi, prieš pradėdami rašyti vadovus apie kalbą, turėtumėte pradėti nuo nuodugnaus raktažodžių tyrimo. Mažai pastangų reikalaujančių raktažodžių stebuklinga formulė yra: didelė paieškos apimtis ir mažas sudėtingumas. Tam galite pasitelkti "Ranktracker" raktažodžių ieškiklį. Taip pat galite patikrinti jau paskelbtų pilnos apimties vadovų skaičių, kad susidarytumėte vaizdą apie savo konkurentus. Tiesą sakant, norėdami įvertinti savo konkurentus, galite pasinaudoti "Ranktracker" SERP tikrintuvu, kuris padės jums įtvirtinti silpnąsias konkurentų vietas.

Tačiau prieš pasirinkdami pagrindinius ir šalutinius raktažodžius įsitikinkite, kad kalba, kuria rašote, nėra pasenusi arba joje nevyksta didelių pokyčių. Kartais galite rasti puikų raktažodį, pagal kurį rašysite kalbos vadovą, ir tik tada suprasti, kad kalbos pavadinimas pasikeitė, t. y. Kairas dabar yra Kairas 1.0. Tokie įrankiai kaip "Ahrefs" iš karto to neparodys.

Jei kalba jau buvo pakeista, ją pamatysite. Tačiau kai kuriais atvejais kalba vis dar gali būti pakeitimų siūlymo stadijoje. Štai kodėl labai svarbu atlikti išsamius namų darbus apie tai, ką kalba ketina daryti toliau.

Patarimas Nr. 2 - labai konkrečiai apibūdinkite vadovo metmenis

Rašant ilgus vadovus apie kalbas svarbiausia yra planas. Tačiau kurti metmenis taip pat yra viena iš sudėtingiausių užduočių. Rašant platesnei auditorijai skirtus vadovus, reikia laikytis tam tikros taisyklės: negalima būti per daug paprastam, bet negalima būti ir per daug techniškam. Visada turite rasti pusiausvyrą tarp abiejų.

Tai reiškia, kad ir pradedantysis programuotojas, ir specialistas turėtų suprasti ir suvokti jūsų mintį. Ir šiuo atveju jūsų konspektas jums labai padeda. Dabar čia ne mažiau svarbu atitikti ieškotojo ketinimą ir atitinkamai parengti turinį.

Mano patirtis rodo, kad ieškodami kalbų vadovų žmonės dažniausiai ieško praktinių žinių. Todėl jūsų apraše daugiau dėmesio turėtų būti skiriama praktiniam mokymuisi ir mažiau bendrųjų žinių, pavyzdžiui, programavimo kalbos istorijai.

(Vaizdas paimtas iš Sulekha)

Patarimas Nr. 3 - Pradėkite vadovą nuo mažiau sudėtingų dalykų

Kai pagaliau pradėsite rašyti kalbos vadovą, būtinai pradėkite nuo pagrindinių dalykų, o paskui vis labiau sudėtingėkite. Jei rašote apie tokią kalbą kaip Python, trumpai ir glaustai pristatykite ją iš pat pradžių. Užsirašykite visus svarbius ir įdomius faktus apie kalbą ir pradėkite juos barstyti pradžioje. Kad skaitytojas užsikabintų už tinklaraščio, rekomenduojama pridėti statistinių duomenų, pavyzdžiui, koks procentas žmonių naudoja šią kalbą ir pan. Taip pat galite galvoti apie tai, kad tai yra atsakymai į klausimus _kas, kada, _ir _kodėl_ kalba.

Tada turite paminėti keletą populiarių projektų, kurie buvo sukurti naudojant šią programavimo kalbą. Daugeliu atvejų žmonės nežino, kad programa, kuria jie kasdien naudojasi, yra iš dalies arba visiškai užkoduota tam tikra programavimo kalba. Dėl to jie yra suintriguoti ir smalsūs, todėl skaito toliau. Tiesą sakant, kartais paminėjus šiuos įdomius faktus vadove, vadovas tampa priimtinesnis mažiau patyrusiems programuotojams.

Taip pat galite apsvarstyti galimybę palyginti pagrindinę kalbą ir jos konkurentą. Tai skaitytojui suteiks naują požiūrį. Apskritai pirmuosius 500-600 žodžių stenkitės skirti kalbai pristatyti. Tačiau stenkitės neperžengti šios ribos.

Patarimas Nr. 4 - Daug dėmesio skirkite mėsingai vadovo daliai

Kaip minėta, žmonės, kurie ieško rašytinių vadovų internete, ieško praktinių patarimų ir kalbos ypatumų. Skaitydami programavimo kalbos dokumentaciją taip pat pastebėsite tam tikrą dėsningumą. Kai kurie dalykai yra pastovūs visose jose. Tai duomenų tipai, kintamųjų tipai, karkasai, bibliotekos, įrankiai ir kt.

Tai rodo, kad dėl šių ypatumų negalima daryti kompromisų ir juos visada reikia paminėti. Nors kiekviena programavimo kalba turi daugybę skirtingų karkasų, bibliotekų ir įrankių, turėtumėte pasirinkti 3 populiarius kiekvienos kalbos elementus ir juos pridėti. Šiuo atžvilgiu jums gali labai padėti oficialios kalbų "GitHub" paskyros.

Dabar jums gali kilti klausimas, kad jei ši informacija jau yra "GitHub", kodėl turėtumėte ją įtraukti į savo vadovą? Na, "GitHub" esančią informaciją paprastai sunku rasti, nes ten yra šimtai failų. Taigi, sutelkdami dėmesį į svarbiausius dalykus labai padėsite, nes užpildysite spragą greitai pateikdami skaitytojams 3 svarbiausias bibliotekas, karkasus, įrankius ir t. t. Be to, skaitytojai taip pat galės gauti didžiausią naudą iš vadovo.

Patarimas Nr. 5 - padvigubinkite mokymosi dalį

Pradėję rašyti pagrindinę vadovo dalį, kurioje pateikiami kalbos ypatumai, turėtumėte užtikrinti, kad skaitytojui suteiksite vertę praktiškai pritaikydami tai, ką parašėte.

Daugumoje šiandien internete prieinamų vadovų nėra kodavimo. Jei esate ne techninio išsilavinimo, taip pat nežinosite apie kodavimą. Tačiau straipsnyje paminėjus pagrindinius kodavimo veiksmus, ypač naudojant jūsų paminėtus karkasus, bibliotekas ir įrankius, jūsų vadovas gali būti vertingesnis.

Bet kaip galite programuoti, jei nieko apie tai neišmanote? Čia jums gali padėti Bardas arba ChatGPT, arba "Ranktracker" dirbtinio intelekto straipsnių rašytojas, kuris padės jums, tarkime, užkoduoti paprasčiausią išmaniąją sutartį 3 paprastais žingsniais. Jį gali patikrinti draugas ar pažįstamas programuotojas arba paskelbti programuotojo forume, kad įsitikintumėte, jog tai, ką parašėte, yra teisinga.

Tai padidins jūsų, kaip tinklaraščio savininko ar rašytojo, autentiškumą ir autoritetą.

Apibendrinant,

Rašyti ilgus techninius vadovus nėra lengva užduotis, ypač jei neturite daug žinių apie programavimo žargoną. Kils įvairių iššūkių. Tačiau parašę pirmuosius 2-3 programavimo kalbų vadovus, viską suprasite. Tai veikia kaip procesas. Nors pirmiau minėti patarimai gali būti ne pati tiksliausia programavimo kalbų vadovų rašymo formulė, jie tikrai gali padėti jums, kaip žmogui, nepriklausančiam techniniam išsilavinimui, suderinti savo vadovus ir suteikti jiems struktūrą.