Pagsulat

Mga pangungusap

Ang default na pangungusap ay naglalagay muna ng subject, tapos ang verb, tapos ang object, at humihinto. Karamihan sa mga pangungusap sa site ay sadyang ganito ang pagkakabuo: apat na wika ang sineserbisyuhan ng pagsusulat, at maraming mambabasa ang bumabasa nito sa wikang hindi nila una. Walang extra na hinihingi ang isang simpleng pangungusap; ang magarbong konstruksyon ay inilalaan para sa iisang sandali sa bawat seksyon kung saan tumataas ang argumento.

• Baligtad na bukas. Ang pangungusap na nagtatago ng subject ay nagpapahintay sa mambabasa. Mas maganda ang “Nagiging maintenance bill ang pangatlong ayos” kaysa sa “ang tahimik na nagiging maintenance bill ay ang pangatlong ayos”.
• Mga abstraction na binuhay. Ang isang dahilan ay hindi nagbubunga at ang isang release ay hindi tumatabi. Ang mga bagay na walang buhay ay inilalarawan, hindi binibigyan ng verb ng tao: “ikaw na mismo ang gagawa nang mano-mano ng ibibigay sana ng library nang libre”.
• Dekorasyong buntot. Kapag lumapag na ang punto, ang palamuting clause na nakasabit sa dulo ay may dalang ritmo pero walang impormasyon, at itinutuon ang pansin sa pagsusulat. Tinatanggal ito.
• Ang talatang paulit-ulit na nagpapatunay. Punto, ebidensya, usad. Ang talatang inuulit ang punto nito sa ibang salita ay mababasang kawalan ng tiwala sa mambabasa. Takpan ang huling pangungusap: kung lumalapag pa rin ang talata, tanggalin ang pangungusap na iyon.

Ang pagsusulit ay basahin ang talata nang malakas. Ang anumang pangungusap na magpapabalik sa iyo para hanapin ang subject ay pinapatag, at isang inversion bawat seksyon, nakalagay kung saan ito karapat-dapat, ang siyang hangganan.

Simpleng salita

Panalo ang maikli at karaniwang salita laban sa pinalobo. Ang marketing na bokabularyo (robust, seamless, cutting-edge) ay nag-aangkin ng kalidad sa halip na ipakita ito, kaya isang konkretong katotohanan ang pumapalit. Ganoon din ang mga pampuno at pormal na padding: gamitin sa halip na i-leverage.

Nababawi ng isang salita ang puwesto nito kapag ito ang literal na teknikal na termino: ang software framework ay framework, ang dynamic dispatch ay dynamic. Ang marketing na kahulugan ng parehong salita ay hindi kailanman pumapasa.

Tatlong mas maliit na panuntunan ang kasama nito. Ang mga idyoma ay pinapalitan ng literal nilang kahulugan para hindi na kailanganing buksan ng mambabasa sa pangalawang wika ang nakatiklop na parirala. Ang mga acronym at pangalan ng tool ay binabaybay sa unang paggamit: “SWC (ang Speedy Web Compiler)”. At ang timbangang konstruksyon, “hindi ito X, ito ay Y”, ay muling sinasabi bilang positibong pahayag, ang kalahating may dala ng impormasyon.

Pagbaybay

Ang prosa ay nasa British English: behaviour, colour, organise, licence. Ang dalawang eksepsiyon ay sinadya at parehong nasa code, hindi sa prosa. Pinapanatili ng isang code identifier kung anumang ispeling ang ginagamit ng API nito, kaya ang color property ay nananatiling color. At sa buong pagsulat tungkol sa Module Federation, ang artifact ay isang terminong teknikal (isang na-publish, na-version na module), kaya pinapanatili nito ang ispeling na iyon habang ang karaniwang prosa ay isinusulat pa ring artefact.

Case

Sentence case ang istilo ng bahay: ang mga pamagat ng pahina, section heading, article heading, button at label ay nilalagyan ng malaking titik ang unang salita at anumang pantanging ngalan, at wala nang iba. Ang itaas na navigation ang tanging eksepsiyon, na pinapanatili sa title case.

Mga petsa

British ang mga petsa. Binabaybay nang buo ng petsa ng artikulo ang buwan: 29 March 2026. Pinapaikli ng saklaw ng tungkulin ang buwan at pinapanatili ang taon, Mar 2016 hanggang sa kasalukuyan, at nagtatapos ang bukás na saklaw sa salitang Present, hindi kailanman sa nakabitin na gitling.

Bantas

Ang serial comma ang default: labels, hints, and states. Ang mga tandang padamdam ay hindi ginagamit sa prosa. Ang truncation at loading state ay gumagamit ng iisang ellipsis character, ang isang aside ay nasa mga comma o parentheses, at ang isang metadata row ay naghihiwalay ng mga bahagi nito gamit ang middot. Ang tatlong tuldok na magkakasunod ay para sa code, hindi sa mga pangungusap. Ang em-dash ang pinakamadalang na bantas sa site: comma, colon, parentheses at tuldok ang gumagawa ng pang-araw-araw na trabaho, at nawawalan ng bisa ang dash na ginagamit kahit saan. Dalawang lugar na lang ang natitira para rito: ang label na katapat ng paliwanag nito, gaya sa mga reference row, at ang bihirang aside na walang ibang bantas na kakayanin. Hindi nito kailanman pinagdudugtong ang dalawang malayang pangungusap; tuldok o kolon ang bagay doon.

Mga link

Inilalarawan ng teksto ng link kung saan ito papunta. Hindi kailanman nili-link ng site ang mga salitang click here o read more, o isang payak na here o this; ang isang link ay nababasa bilang ang bagay na tinuturo nito.

Mga pangalan ng brand at produkto

Pinapanatili ng mga pangalan ng produkto ang kanilang opisyal na ispeling at casing. Ang React Native at Module Federation ay tig-dalawang salita na naka-title case; ang Pokémon at Pokédex ay laging may accent; ang App Store ay dalawang salita. Kung saan may eksaktong anyo ang isang pangalan, tumbasan ito sa halip na ayusin.

Ang skim layer

Ang mahahabang technical na artikulo ay sini-skim muna bago basahin, at binabalikan pagkatapos. Ang bold ang nagmamarka ng mga desisyon, para kahit mabilisang dumaan ang mambabasa sa page, dala pa rin niya ang mga konklusyon. Dinadala ng mga link ang bawat claim sa artikulong sumusuporta rito. Puwedeng gumamit ang isang artikulo ng isang decorative na naka-highlight na linya para sa pinakamatalas nitong panuntunan, sa bahagi kung saan pinakasiksik ang prose. Karapat-dapat lang ito sa puwesto kapag binubuod nito ang buong bahaging nakapaligid dito. Kung inuulit lang nito ang katabing talata, palamuti itong nagpapanggap na diin; mas mabuti pang wala kaysa sa isang hindi nararapat. Iba ang mga semantic callout para sa panganib, tip, babala at impormasyon: gumamit ng dami na kailangan ng nilalaman kapag malinaw ang trabaho ng bawat isa. Dapat suriin ang tuloy-tuloy na prose na umaabot sa ilang daang salita: panatilihin ito kung iisa at malinaw ang trabaho nito, o hatiin gamit ang kapaki-pakinabang na code block, table, larawan, callout o naka-highlight na linya. Ang diin na nasa lahat ng dako ay walang binibigyang-diin.

Pag-edit pagkatapos ng draft

Maaaring tama sa teknikal na bahagi ang draft pero dala pa rin nito ang scaffolding ng editor. Mananatili lang ang version history, mga alternatibong tinanggihan at verification detail kapag binabago ng mga iyon ang ibini-build, dini-diagnose o pinagpapasyahan ng mambabasa.

• Isang mechanism o desisyon bawat talata. Maaaring sumama rito ang ebidensya at resulta; magsisimula sa bagong talata ang pangalawang causal chain.
• Ulitin ang skim pass pagkatapos ng huling pagputol. Binabago ng pag-ikli kung aling mga desisyon ang karapat-dapat sa bold, at maaaring maging pag-uulit ang dating anchor.
• Itali ang Mga Sanggunian sa mga claim na nanatili. Kapag inalis ang claim sa body, alisin din ang source row nito; itinatala ng listahan ang mga nailathalang claim, hindi ang browsing history ng editor.

Cross-linking

Malayang nagtuturo ang mga post sa isa’t isa: ang pangungusap na bumabanggit sa token-refresh post ay naka-link doon, at pinapangalanan ng link text ang pupuntahan gaya sa itaas. Puwede pang tumuro ang mga link sa mga post na hindi pa lumalabas. Ang link sa hindi pa na-publish na post ay lumalabas bilang plain text, kaya walang kailanman nagre-404, at kusang nagiging link ang mga salitang iyon kapag na-publish ang pupuntahan. Ang mga forward reference ay isinusulat nang isang beses at nareresolba nang kusa.

Bawat post ay maaaring pumili ng hanggang tatlong related post; ang mga walang pinili ay babagsak sa mga shared tag. May further-reading shelf na nagdadagdag ng mas tahimik na mga post na malamang hindi pa nakikita ng mambabasa, na may limit na siyam sa kabuuan, para manatili itong rekomendasyon at hindi archive.

Sa loob ng isang serye, ang previous at next ay nananatili sa loob ng serye: ang part five ay tumuturo sa parts four at six, hindi kailanman sa walang kaugnayang post na nagkataong lumabas katabi nito. Sa mga dulo lang ng serye babagsak ang mga arrow sa katabing post ayon sa petsa.

Pagtutol sa sulat

Maraming tinututulan ang technical writing dito: mga default, mga sikat na library, mga minanang paniniwala. Ang rule ay i-steelman muna. Ilahad ang kabilang panig sa pinakamalakas nitong bersyon, kilalanin ang tama nito, saka ipakita kung saan ito huminto sa paggana para sa kasong pinag-uusapan. Ang pagtutol ay dumadating bilang obserbasyon tungkol sa akma, hindi bilang paghatol.

Dalawang gawi ang sumusuporta rito. Ang hindi absolute ay hindi isinusulat bilang absolute: ang “X never works” ay nagiging “X was not designed for Y”. At walang defensive opener: ang mga pangungusap ay hindi nagsisimula sa “To be clear” o “Just to clarify”.

Tatlo pang gawi ang nagpapanatiling tapat sa mga argumento. Ang desisyon sa disenyo ay pinapangalanang desisyon, hindi dinadamitan ng batas ng kalikasan: ang “ang host ang may-ari ng navigation” ay pili ng build na ito, at ang pagsasabi nito ay nag-aanyaya sa mambabasa na sundan ang pangangatwiran sa halip na maghanap ng kontra-halimbawa. Ang “dahil” ay inilalaan para sa sanhi na naipakita na ng teksto; kung ang pahayag ay nakasandal sa hinuha o kaugalian, sinasabi ng pagsusulat na “nagmumungkahi ito” o “ang karaniwang dahilan ay”. At ang mga heading ay naglalarawan ng bagay na akma, hindi ng kabiguan: “Kung saan may hangganan ang X” sa halip na “Bakit bumabagsak ang X”. May ikaapat na kasama nila, dahil ito ang hindi kayang mahuli ng isang editor. Kapag may ipinapaliwanag ang isang sulatin kung bakit ganoon kumilos ang isang bagay, ang paliwanag na iyon ay tinitingnan laban sa mismong bagay — ang source ng library, ang dokumentasyon ng vendor, ang tagged na code na iniuugnay nito — bago ilathala. Ang ayos na napatunayan sa panonood na gumagana ay karapat-dapat sa pangungusap tungkol sa napanood; hindi ito karapat-dapat sa mekanismong walang nagbasa. At hindi natatapos ang pagwawasto sa linyang itinama: pagkatapos, binabasa muli ang buong piyesa, dahil ang claim na naayos sa isang talata ay maaari pa ring salungatin ng ibang talata sa ibaba. Kapag hindi nagtutugma ang prosa at ang nailathalang code, ang unang tanong ay kung alin sa dalawa ang dapat magbago — kung minsan, ang tapat na ayos ay nasa code, para maging totoo ang pangungusap. At ang mga hakbang ng isang tutorial ay may parehong pamantayan tulad ng mga claim nito: inuulit ang mga hakbang mula sa eksaktong panimulang punto na binanggit ng piyesa, sa isang malinis na directory, at inihahambing ang resulta sa tapos na sanggunian, dahil ang hakbang na hindi na kailangan ng makina ng may-akda ang siyang hindi malalaktawan ng mambabasa. Pinapangalanan ang mga bersyon, hindi ipinapalagay: ang install na walang takdang bersyon ay sumusunod sa kung ano ang ihain ng registry sa araw na iyon, at sinusundan ng mambabasa ang piyesa sa ibang araw. At ang inilalathala ng isang piyesa sa isang registry ay hindi inilalathala nang dalawang beses: ang isang bersyon, kapag nailabas na, ay nananatili ang mga byte nito habang-buhay, at anumang pagbabago ay lalabas bilang bagong bersyon, dahil naaalala ng lockfile ng mambabasa ang binura ng may-akda pagkatapos. Ang pahinang hindi nairender ay isang pagkabigo na dapat tanggihan ng pipeline, hindi babalang itinatala lamang: inihahambing ng build gate ang bawat nailathalang pahina sa pinagmulan nito at pinipigilan ang deploy kapag kulang ang katawan. At ang isang gate ay sinusuri tulad ng anumang claim: ang tseke na sumisiyasat lamang sa kung ano ang umiiral na, o nagbibilang sa saklaw na mas malawak kaysa sa binabantayan nito, ay nagpapalusot ng mga build na dapat nitong ibagsak; ang mga bulag na bahagi ng gate ay mga natuklasan din. At ang isang test ay sumasailalim sa parehong disiplina: ang suite na gumagamit ng gaya-gaya ng bagay na sinusubok ay ang gaya-gaya lang ang napapatunayan, kaya ikinakabit muna ang assertion sa tunay na code — sa tunay na reducer, sa tunay na boundary — bago magkaroon ng saysay ang berde nito.

Mga social teaser

Kapag ibinahagi ang isang post sa LinkedIn, teaser ang ibinabahagi, hindi buod. Iisa lang ang trabaho nito: magbukas ng curiosity gap na isasara ng artikulo: maglahad ng tensyon, magbanggit ng espesipikong detalye nang hindi ipinapaliwanag, at ituro pasulong. Kung nasiyahan na ang mambabasa nang hindi nag-click, pumalya ang teaser.

• Mga 500 character, bawat pangungusap ay may pinaglalaban.
• Walang link sa body; ang link ay nasa unang komento.
• Tatlo hanggang limang hashtag, hindi hihigit.
• Walang exclamation mark, at walang rhetorical question bilang pang-akit.
• First person singular, isinulat mula sa senior authority: walang self-deprecation, walang imbentong war story.
• Hindi kailanman pinapangalanan ang mga employer o internal project.