Skjalateymi birta sjaldan Markdown á einum stað. Efni getur byrjað í drögum, farið í repository á GitHub, síðan í CMS, þekkingargrunn eða in-product hjálp. Sama efni getur því lifað í mörgum renderum áður en notandi sér það.
Converty Markdown-staðfestirinn er gagnlegur í glugganum fyrir birtingu. Hann sýnir renderaða útgáfu og viðvarar um atriði sem hrái textinn felur: heading-stökk, tóma linka, vantaðan alt text eða code fence án tungumáls.
Markdown er ekki eitt einsleitt birtingarumhverfi
README á GitHub hegðar sér ekki alltaf eins og CMS-blokk eða docs-platform. Þó setningafræðin sé svipuð geta smávillur kostað mismikið eftir yfirborði. Þess vegna þarf review að byrja í source, en enda með destination-aware skoðun.
Validatorinn á að grípa almennu höfundamistökin áður en full docs build eða CMS-preview þarf að útskýra þau.
Tvær spurningar
Pre-publish pass á að svara tveimur spurningum:
- Lítur skjalið út eins og lesandinn á að sjá það?
- Er uppbyggingin nógu heil til að lifa næsta handoff?
Forskoðunin svarar þeirri fyrri. Viðvaranirnar hjálpa við þá seinni.
Hagnýt röð
- Límdu draftið í Markdown-staðfestinn.
- Lestu renderaða síðuna sem nýr lesandi.
- Lagaðu viðvaranir um headings, linka, myndir og code fences.
- Færðu hreinsaða útgáfu í GitHub eða CMS.
- Gerðu lokaúttekt í markkerfinu fyrir renderer-specific hegðun.
Þessi röð heldur einföldum authoring-villum frá þyngri útgáfukerfum. Hvernig á að finna Markdown-vandamál fyrir birtingu er grunnleiðbeiningin; þessi grein setur hana í docs-samhengi.
Hrátt HTML þarf varlega forskoðun
Skjöl erfa stundum HTML-fragment úr gömlum CMS-útflutningi eða handvirkum lagfæringum. Forskoðun þarf að vera nógu raunhæf til að hjálpa, en hún á ekki að treysta óyfirförnu HTML blindandi. Hreinsuð forskoðun hjálpar þar.
Ef efnið er viðkvæmt skaltu líka lesa Eru online-breytar öruggir fyrir vinnuskrár?. Vafratengd Markdown-yfirferð getur verið rétt fyrir mörg docs-draft, en ekki fyrir allt innra efni.
Opnaðu Markdown-staðfestinn áður en áfangakerfið verður fyrsti alvöru reviewerinn.
