Zoznamy krokov: Ako písať návody krok za krokom
Vytvárajte zoznamy krokov, ktoré vysvetľujú každú akciu, jej účel, signál úspechu a spôsob obnovy, aby ľudia aj stroje mohli s istotou sledovať inštrukcie.
Zoznam krokov je usporiadaný postup, ktorý čitateľa prevedie od známeho východiskového stavu k overiteľnému výsledku. Jeho čísla nesú význam: krok 2 závisí od kroku 1 a zmena poradia by mohla znamenať stratu práce, spôsobiť chybu alebo znemožniť dokončenie. Každý krok vysvetľuje viac než len to, kam kliknúť. Uvádza dôvod, akciu, stav úspechu a spôsob obnovy potrebný na pokračovanie.
Potvrďte, že poradie mení výsledok. Prečo: Číslovanie sľubuje závislosť, takže falošné poradie zavádza čitateľov aj stroje. Akcia: Skúste vymeniť dve akcie. Úspech: Aspoň jedna výmena by zmenila, zablokovala alebo zneplatnila výsledok. Obnova: Ak každá akcia stále funguje, nahraďte postupnosť odrážkami alebo kontrolným zoznamom.
Napíšte pozorovateľný stav úspechu. Prečo: Čitatelia potrebujú dôkaz, že akcia fungovala, skôr než pokračujú. Akcia: Pomenujte, čo môžu vidieť, zmerať, stiahnuť alebo otestovať. Úspech: Osoba, ktorá nepozná návrh, by vedela rozhodnúť o úspechu alebo neúspechu. Obnova: Ak úspech závisí len od úsudku, pridajte konkrétnu hranicu alebo príklad.
Pridajte spôsob obnovy pri zlyhaní. Prečo: Postup, ktorý predpokladá dokonalé vykonanie, necháva čitateľa napospas pri prvej chybe. Akcia: Uveďte najbezpečnejšiu opravu, opakovanie alebo eskaláciu. Úspech: Čitateľ sa dokáže vrátiť do očakávaného stavu bez hádania. Obnova: Ak neexistuje bezpečná obnova, varujte pred akciou a uveďte, kto môže pomôcť.
Tento živý príklad je zámerne kompaktný, no napĺňa zmluvu o kroku. Zvyšok tejto stránky definuje, ako konzistentne vytvárať tento prvok naprieč publikačnými systémami.
Prečo na tomto prvku záleží
Čitatelia postupov chcú vedieť, čo majú urobiť teraz, prečo je to dôležité, či to fungovalo a čo robiť, keď sa realita líši od ideálneho scenára. „Kliknite na Uložiť“ odpovedá len na prvú otázku. Necháva čitateľa domýšľať si, aké potvrdenie očakávať a čo znamená zlyhanie.
Zoznam krokov túto neistotu znižuje vytvorením opakovaného rozhodovacieho rytmu. Imperatívny názov začína príkazom ako „Pripojte,“ „Overte“ alebo „Publikujte.“ Dôvod stanovuje relevantnosť skôr, než čitateľ investuje úsilie. Akcia poskytuje dostatok detailov na vykonanie. Stav úspechu robí dokončenie pozorovateľným. Spôsob obnovy zabraňuje tomu, aby sa zlyhaná akcia stala slepou uličkou. Toto je zmluva o kroku a každý viditeľný krok musí spĺňať všetkých päť častí.
Rovnaká pravidelnosť zlepšuje strojovú extrahovateľnosť: schopnosť vyhľadávača, AI agenta alebo transformačného systému izolovať inštrukciu bez straty jej úlohy. Stabilné poradie, popisné názvy, explicitné výsledky a ohraničené pokyny na obnovu umožňujú stroju rozlíšiť inštrukciu od jej overenia.
Čísla samy osebe tento význam nevytvárajú. Odhaľujú význam, ktorý obsah už má. Keď je postupnosť pravá, číslovanie komunikuje závislosť skenujúcemu čitateľovi a zachováva pozíciu pre štruktúrované dáta. Keď je postupnosť umelá, číslovanie vytvára falošný sľub.
Kedy to použiť
Použite zoznam krokov, keď čitateľ musí vykonať postup v poradí a každá dokončená akcia vytvára východiskový stav pre ďalšiu. Vhodné použitia zahŕňajú nastavenie účtu, konfiguráciu softvéru, opakovateľný analytický pracovný postup, migráciu, postup opravy alebo publikačný proces so závislosťami.
Nepoužívajte zoznam krokov len preto, že čísla vyzerajú autoritatívne. Použite odrážky, keď sú položky možnosti, príklady, ingrediencie alebo charakteristiky. Použite kontrolný zoznam, keď sú položky nezávislé body, ktoré možno overiť v ľubovoľnom poradí. Použite porovnávaciu tabuľku, keď si čitateľ vyberá medzi alternatívami, nie smeruje k jednému výsledku. Použite bežný súvislý text, keď ide o jeden alebo dva zrejmé úkony a ani jeden nepotrebuje nezávislé overenie.
Prípady na hranici spôsobujú najviac zneužití:
- „Desať spôsobov, ako zlepšiť vstupnú stránku“ je zoznamový článok, pokiaľ položka 4 nevyžaduje výstup položky 3.
- „Pred publikovaním skontrolujte názov, odkazy, obrázky a autora“ je kontrolný zoznam, pretože poradie neurčuje platnosť.
- „Vyberte plán, zadajte platobné údaje a potvrďte nákup“ je zoznam krokov, pretože každý stav odomyká ďalší.
- „Ak import zlyhá, skúste A, B alebo C“ je návod na riešenie problémov. Stáva sa zoznamom krokov len vtedy, keď sa diagnostické vetvy musia vyskúšať v definovanom poradí.
- Chronológia opisuje, čo sa stalo v čase. Nie je to postup, pokiaľ čitateľ nemôže vykonať jeho akcie na dosiahnutie uvedeného výsledku.
Vykonajte test výmeny vždy, keď je zámer nejasný: vymeňte dve susedné položky a zistite, či postup zostáva správny. Ak je každá výmena neškodná, poradie je dekoratívne a toto je nesprávny prvok.
Kam ho umiestniť
Zoznam krokov patrí za časť, kde čitateľ rozumie výsledku a má vstupy potrebné na začatie. Umiestnite blok predpokladov priamo nad neho, ktorý uvádza východiskový stav, oprávnenia, súbory alebo dáta, nástroje, zásoby, čas a nezvratné riziká. Vynechajte polia, ktoré sa neuplatňujú; nikdy neskrývajte požadovaný vstup v kroku 4.
Umiestnite blok výsledku priamo pod posledný krok. Uvádza dokončený stav, artefakt alebo stav, ktorý by mal mať čitateľ, a ďalšiu rozumnú akciu. Týmto sa postup uzatvára namiesto toho, aby čitateľ musel domýšľať, že absencia ďalšieho čísla znamená úspech.
Prvok sa môže objaviť raz ako hlavný postup na stránke návodu alebo niekoľkokrát ako jasne pomenované fázy v dlhšom tutoriáli. Nadpis fázy musí vysvetľovať priebežný výsledok a číslovanie musí buď pokračovať naprieč fázami, alebo používať explicitné identifikátory ako „Fáza 2, krok 1.“ Nespúšťajte potichu od 1.
Zoznam krokov nesmie stáť priamo vedľa iného číslovaného zoznamu s iným účelom; nadpis alebo prechod musí vysvetľovať hranicu. Nesmie začínať pred varovaním, ktoré mení, či je úloha bezpečná. Neumiestňujte všeobecnú výzvu na akciu medzi kroky, referencie medzi akciu a jej stav úspechu ani nesúvisiacu porovnávaciu tabuľku uprostred postupu. Podporný materiál patrí do príslušného kroku len vtedy, ak pomáha dokončiť túto akciu; inak ho umiestnite pred alebo za celú postupnosť.
Anatómia
Anatómia má tri oblasti na úrovni kolekcie a päť opakovaných oblastí na úrovni kroku:
- Predpoklady: východiskový stav, prístup, nástroje, zásoby, čas a dôležité obmedzenia.
- Označenie postupnosti: popisný nadpis, ktorý pomenúva postup a jeho výsledok.
- Číslo kroku: sémantická pozícia generovaná rendererom usporiadaného zoznamu, nie ručne písaná do názvu.
- Imperatívny názov: jedna fráza vedená akciou, ktorá skenujúcemu čitateľovi umožňuje predvídať úlohu.
- Prečo: závislosť, riziko alebo prínos, ktorý odôvodňuje vykonanie kroku teraz.
- Akcia: presná inštrukcia vrátane relevantného umiestnenia, vstupu a voľby.
- Úspech a obnova: pozorovateľný hotový stav nasledovaný najbezpečnejšou reakciou, keď sa tento stav nedostaví.
- Výsledok: konečný stav a to, čo s ním môže čitateľ robiť.
Legenda zostáva na stránke, pretože označenia sú obsah, nie grafika. Ak sa dizajn zmení, rovnaké sémantické oblasti musia zostať identifikovateľné bez úpravy pixelov.
Príklady dizajnu
Predvolený variant spracúva väčšinu redakčných postupov. Kompaktný variant môže zmenšiť medzery, ale nemôže odstrániť polia zmluvy. Variant s pomocou snímok obrazovky spája nejednoznačný krok rozhrania s jedným zameraným obrázkom. Fázový variant zoskupuje dlhý postup podľa priebežných výsledkov pri zachovaní súvislej celkovej postupnosti.
Žiadny „minimálny“ variant nesmie vynechávať dôvody ani spôsoby obnovy. Prezentácia môže komprimovať biele miesto, nie redakčnú zmluvu.
Parametre
Tieto parametre definujú zdrojový obsah, nie voliteľnú vizuálnu dekoráciu. Stĺpec zdroja ukazuje, či hodnota pochádza z atribútu, tela vnorenej položky alebo jej prvého nadpisu.
| Názov | Typ | Povinný | Min/max | Predvolená hodnota | Zdroj | |
|---|---|---|---|---|---|---|
title | Prostý reťazec | Áno | 3–10 slov | Žiadna | Prvý nadpis v rodičovskom tele | |
variant | Enum | Nie | default, compact alebo phased | default | Atribút rodiča | |
totalTime | Trvanie ISO 8601 | Nie | 1 minúta až 30 dní | Vynechaný | Atribút rodiča, podporený viditeľným textom času | |
prerequisites | Markdown blok | Áno, keď existuje nejaký predpoklad | 1–6 položiek; 10–120 slov | Vynechaný len keď neexistujú žiadne | Telo rodiča pred položkami | |
steps | Kolekcia usporiadaných položiek | Áno | 3–10 krokov | Žiadna; cieľ 5 | Telá vnorených položiek | |
step.title | Prostý reťazec | Áno | 2–8 slov; 60 znakov | Žiadna | Prvý nadpis v tele položky | |
step.why | Prostý Markdown | Áno | 10–35 slov | Žiadny | Telo položky | |
step.action | Prostý Markdown | Áno | 15–70 slov | Žiadna | Telo položky | |
step.success | Prostý Markdown | Áno | 8–30 slov | Žiadny | Telo položky | |
step.recovery | Prostý Markdown | Áno | 8–40 slov | Žiadny | Telo položky | |
step.image | Cesta k assets relatívna ku koreňu | Nie | 0–1 obrázok na krok | Vynechaný | Atribút položky; len ak asset existuje | |
supply | Kolekcia prostých reťazcov | Nie | 0–8 viditeľných položiek | Vynechaný | Telo rodiča — predpoklady | |
tool | Kolekcia prostých reťazcov | Nie | 0–8 viditeľných položiek | Vynechaný | Telo rodiča — predpoklady | |
outcome | Markdown blok | Áno | 15–80 slov | Žiadny | Telo rodiča za položkami |
Bežná dĺžka na krok je 50–140 slov v piatich poliach zmluvy. Kratšie kroky zvyčajne vynechávajú zdôvodnenie alebo overenie; dlhšie kroky zvyčajne skrývajú niekoľko akcií.
Syntax a príklady kódu
Kánonická štruktúra sa riadi pravidlami písania prvkov : rodič obsahuje nastavenia kolekcie a každý opakovaný krok je vnorená položka. Príklady nižšie kódujú rovnaký dvojkrokový fragment pre jasnosť mapovania; publikovateľný postup by mal normálne obsahovať aspoň tri kroky.
Prenosná Markdown direktíva
:::step-list{totalTime="PT15M" variant=default}
## Pripojte a overte zdroj údajov
Predpoklady: administrátorský prístup a identifikátor nehnuteľnosti.
::item
### Otvorte obrazovku pripojenia nehnuteľnosti
**Prečo:** Začatie zo správnej nehnuteľnosti zabraňuje pripojeniu údajov k nesprávnemu účtu.
**Akcia:** Otvorte Nastavenia, vyberte Zdroje údajov a zvoľte identifikátor nehnuteľnosti uvedený v bloku predpokladov.
**Úspech:** Názov vybranej nehnuteľnosti sa zobrazí v súhrne pripojenia.
**Obnova:** Ak chýba, potvrďte prístup k účtu a znova načítajte zoznam nehnuteľností.
::
::item
### Spustite test pripojenia
**Prečo:** Úspešný test dokazuje, že prihlasovacie údaje a oprávnenia fungujú pred prvým importom.
**Akcia:** Vyberte Testovať pripojenie a počkajte na odpoveď o stave.
**Úspech:** Rozhranie zobrazí „Pripojené“ s aktuálnym časom.
**Obnova:** Znovu autorizujte účet; ak test stále zlyháva, skopírujte kód chyby pre podporu.
::
Výsledok: zdroj je pripojený a pripravený na prvý import.
:::
Mapovanie Hugo shortcode
{{< step-list totalTime="PT15M" variant="default" >}}
Predpoklady: administrátorský prístup a identifikátor nehnuteľnosti.
{{< step title="Otvorte obrazovku pripojenia nehnuteľnosti" >}}
**Prečo:** Začatie zo správnej nehnuteľnosti zabraňuje pripojeniu údajov k nesprávnemu účtu.
**Akcia:** Otvorte Nastavenia, vyberte Zdroje údajov a zvoľte identifikátor nehnuteľnosti.
**Úspech:** Vybraná nehnuteľnosť sa zobrazí v súhrne pripojenia.
**Obnova:** Potvrďte prístup a znova načítajte zoznam nehnuteľností.
{{< /step >}}
{{< step title="Spustite test pripojenia" >}}...{{< /step >}}
Výsledok: zdroj je pripojený a pripravený na prvý import.
{{< /step-list >}}
Tento zápis definuje adaptérovú zmluvu; autori musia použiť registrovaný renderer stránky, keď je k dispozícii. Táto stránka vykresľuje svoj živý príklad ako sémantický Markdown a nezavádza nový Hugo shortcode.
Mapovanie WordPress bloku
<!-- wp:amicited/step-list {"totalTime":"PT15M","variant":"default"} -->
<!-- wp:amicited/step {"title":"Otvorte obrazovku pripojenia nehnuteľnosti"} -->
<p><strong>Prečo:</strong> Začatie zo správnej nehnuteľnosti zabraňuje pripojeniu údajov k nesprávnemu účtu.</p>
<p><strong>Akcia:</strong> Otvorte Nastavenia, vyberte Zdroje údajov a zvoľte identifikátor nehnuteľnosti.</p>
<p><strong>Úspech:</strong> Vybraná nehnuteľnosť sa zobrazí v súhrne pripojenia.</p>
<p><strong>Obnova:</strong> Potvrďte prístup a znova načítajte zoznam nehnuteľností.</p>
<!-- /wp:amicited/step -->
<!-- /wp:amicited/step-list -->
Výstup platformy sa môže vizuálne líšiť, ale každé pole a jeho význam musia zostať zachované.
Príklady
Dobrý: overte doménu pred zberom údajov
- Pridajte overovací záznam. Prečo: Záznam dokazuje kontrolu nad doménou bez odhalenia prihlasovacích údajov k účtu. Akcia: Skopírujte presnú TXT hodnotu do DNS nastavení domény a uložte ju na koreňovom hostiteľovi. Úspech: Poskytovateľ zobrazí záznam v zozname DNS bez ďalších úvodzoviek. Obnova: Ak chýba, skontrolujte, či pole hostiteľa používa koreňový symbol vyžadovaný poskytovateľom, a počkajte na propagáciu DNS pred opakovaním.
- Potvrďte vlastníctvo v produkte. Prečo: Potvrdenie zabraňuje spusteniu zberu na neoverenej nehnuteľnosti. Akcia: Vráťte sa na overovaciu obrazovku a vyberte Overiť, keď je záznam verejne rozlíšiteľný. Úspech: Stav domény sa zmení na Overené a zobrazí čas overenia. Obnova: Ak overenie zlyhá, vyhľadajte TXT záznam, porovnajte ho znak po znaku a opravte DNS záznam pred ďalším pokusom.
- Spustite prvý zber. Prečo: Overená, ale neaktívna nehnuteľnosť neprodukuje žiadnu základnú líniu. Akcia: Vyberte Spustiť zber a ponechajte predvolený rozsah, pokiaľ projekt nevyžaduje zdokumentovanú výnimku. Úspech: Zobrazí sa zaradená úloha s overenou doménou a aktuálnym časom. Obnova: Ak sa úloha nezobrazí, raz obnovte; potom zachyťte doménu, čas a chybové hlásenie pre podporu namiesto vytvárania duplicít.
Toto funguje, pretože poradie je skutočné, názvy sú imperatívne, kontrolné body sú viditeľné a pokyny pri zlyhaní sú bezpečné.
Zlý: zlepšite článok
- Pridajte interné odkazy.
- Prepíšte úvod.
- Skontrolujte pravopis.
- Pridajte príklady.
Zoznam je zlý z dvoch dôvodov. Po prvé, jeho poradie je ľubovoľné: pravopis by sa dal skontrolovať pred odkazmi a príklady by sa dali pridať pred úvod. Mal by to byť kontrolný zoznam. Po druhé, každá položka len pomenúva činnosť. Žiadna nevysvetľuje, prečo patrí, ako ďaleko zájsť, čo sa považuje za úspech ani čo robiť, keď kontrola zlyhá. Pridanie ďalších slovies by nevyriešilo sémantický nesúlad.
Rozsah a vnorenie
Jeden krok by mal priniesť jednu zmysluplnú zmenu stavu. Niekoľko kliknutí môže patriť do tohto kroku, keď tvoria jednu neprerušenú interakciu a zdieľajú jeden signál úspechu. Napríklad „Vyberte CSV, zvoľte UTF-8 a exportujte súbor“ je jeden krok, ak je pozorovateľným výsledkom stiahnutý CSV. Rozdeľte ho, keď medzivýsledok vyžaduje overenie, iné oprávnenie, výrazné čakanie, rozhodovaciu vetvu alebo odlišný spôsob obnovy.
Použite vetný test: ak názov potrebuje „a“ na spojenie dvoch výsledkov, pravdepodobne obsahuje dva kroky. Použite aj test zlyhania: ak prvá polovica môže uspieť, zatiaľ čo druhá zlyhá, a každá vyžaduje inú obnovu, rozdeľte ich.
Vnorenie je obmedzené na jednu úroveň a tri krátke podkroky. Podkroky objasňujú tesne ohraničenú akciu; nevytvárajú postup vnútri postupu. Povýšte postupnosť na vlastnú stránku, keď má samostatné predpoklady, viac ako tri akcie, viacero snímok obrazovky, viac ako jednu vetvu zlyhania alebo výsledok, ktorý by iná stránka mohla použiť samostatne. Odkazujte na tento podpostup, potom udržujte rodičovský krok zameraný na to, kedy ho vykonať a ako potvrdiť jeho výsledok.
Politika snímok obrazovky na krok
Snímka obrazovky si zaslúži svoje miesto, keď slová nedokážu spoľahlivo identifikovať ovládací prvok alebo stav. Použite ju, keď sú označenia duplicitné, ovládací prvok je skrytý v ponuke, záleží na priestorovom umiestnení, rozhranie používa neznámou ikonu alebo je stav úspechu vizuálne nejednoznačný. Orezajte na oblasť úlohy, zachovajte dostatok kontextu pre orientáciu a popíšte relevantný stav v alternatívnom texte a blízkom texte.
Vynechajte snímku obrazovky, keď je označenie rozhrania jedinečné a stav úspechu možno presne uviesť. Taktiež vynechajte snímky obrazovky rutinných akcií, ako je výber jasne označeného tlačidla Uložiť, príkazov terminálu už zobrazených ako text alebo každej obrazovky prejdenej na ceste k jednej zmysluplnej voľbe. Štrnásť snímok obrazovky pre štrnásť zrejmých krokov mení postup na pomalú, krehkú prezentáciu a robí zmeny rozhrania nákladnými na údržbu.
Použite najviac jednu snímku obrazovky na krok. Ak krok potrebuje obrázky pred, počas a po, jeho rozsah je pravdepodobne príliš široký. Nikdy neodkazujte na asset, kým neexistuje, a nikdy neumiestňujte podstatné inštrukcie len do obrázka.
Schema markup a prístupnosť
Schema markup
je strojovo čitateľný kód, ktorý popisuje význam a vzťahy viditeľného obsahu. Keď stránka skutočne učí úplný postup, zoznam krokov môže napájať objekt HowTo zo Schema.org vyjadrený ako JSON-LD
. Mapovanie je priame:
| Viditeľné pole | Vlastnosť HowTo | Pravidlo |
|---|---|---|
| Názov postupu | HowTo.name | Zhodujte sa s viditeľným nadpisom postupu. |
| Viditeľné trvanie | HowTo.totalTime | Zakódujte ako trvanie ISO 8601, napr. PT15M; nevymýšľajte trvanie len pre markup. |
| Požadované zásoby | HowTo.supply / HowToSupply | Zahrňte len spotrebné vstupy uvedené v predpokladoch. |
| Požadované nástroje | HowTo.tool / HowToTool | Zahrňte len nástroje uvedené v predpokladoch. |
| Usporiadané viditeľné kroky | HowTo.step / HowToStep | Presne zachovajte počet a poradie. |
| Imperatívny názov | HowToStep.name | Zhodujte sa s viditeľným názvom kroku. |
| Prečo, akcia, úspech, obnova | HowToStep.text | Zachovajte všetok viditeľný inštruktážny význam, nielen akciu kliknutia. |
| Obrázok kroku | HowToStep.image | Zahrňte len viditeľný obrázok pripojený k tomuto kroku. |
| Kotva kroku | HowToStep.url | Smerujte na stabilný fragment identifikátora viditeľného kroku. |
Markup musí zrkadliť viditeľný postup presne. Nikdy nepridávajte skryté kroky, nekombinujte dva viditeľné kroky do jednej položky schémy, nepreusporiadavajte ich ani nevynechávajte pokyny na obnovu, aby bola štruktúrovaná verzia kratšia. Neaplikujte HowTo len preto, že stránka obsahuje číslovaný zoznam; stránka musí opisovať dokončiteľný proces.
Prístupnosť začína značkou <ol> obsahujúcou jeden <li> na krok. Číslo a poradie musia zostať dostupné pre asistenčné technológie. Nepíšte čísla do nadpisov, pretože skopírovaný text, CSS počítadlá a výstup čítačiek obrazovky sa môžu líšiť. Používajte logické úrovne nadpisov, stabilné identifikátory fragmentov, popisné alternatívne texty snímok a textové označenia úspechu a obnovy namiesto farby samotnej.
Vyhýbajte sa interaktívnym ovládacím prvkom, ktoré menia poradie krokov bez oznámenia zmeny. Ak sa kroky zbalia, ovládací prvok potrebuje prístupný názov a rozbalený stav a klávesnicové zameranie musí zostať predvídateľné. Tlačiteľný výstup a výstup bez JavaScriptu musí zachovať celý postup.
Pravidlá písania
Píšte 3–10 krokov, zvyčajne 50–140 slov každý. Každý 2–8-slovný názov začnite imperatívnym slovesom a opisujte jeden výsledok. Vysvetlite dôvod pred akciou, ktorú by čitatelia mohli preskočiť, preusporiadať alebo nepochopiť. Používajte pokojný, priamy jazyk.
Každý krok musí obsahovať päť zmluvných polí, hoci renderovaný dizajn nemusí opakovať objemné označenia, keď ich typografia sprostredkúva prístupne. Stav úspechu musí byť pozorovateľný: zmení sa stav, existuje súbor, hodnota spadá do uvedeného rozsahu, príde e-mail alebo test prejde. „Všetko vyzerá dobre“ nie je pozorovateľné. Obnova musí byť bezpečná, konkrétna a primeraná; rozlišujte medzi opakovaním a vrátením späť a identifikujte eskaláciu, keď čitateľ nemôže stav opraviť.
Neumiestňujte nesúvisiace pozadie, propagačné výzvy na akciu, referencie, druhý nezávislý postup ani niekoľko rozhodovacích vetiev dovnútra kroku. Presuňte pozadie nad zoznam, propagáciu pod výsledok a rozsiahle vetvy do sekcií riešenia problémov. Nepoužívajte „jednoducho,“ „samozrejme“ ani „len“ pre akciu, ktorá môže zlyhať. Nikdy nesľubujte obrazovku, označenie, čas ani výsledok, ktorý produkt v skutočnosti neposkytuje.
Typy príspevkov, ktoré ho používajú
| Typ príspevku | Použitie | Pozícia |
|---|---|---|
| Návod (How-to guide) | Vždy; usporiadaný postup je hlavným sľubom stránky. | Po predpokladoch a pred výsledkom, riešením problémov a ďalšou akciou. |
| Tutoriál | Zvyčajne; použite ho pre každú fázu riadenú závislosťami, nie pre koncepčné učenie. | Po koncepte potrebnom pre fázu a pred overením fázy. |
| Stránka riešenia problémov | Niekedy; len keď diagnostika alebo opravy musia bežať v bezpečnom poradí. | Po príznaku a bezpečnostných kontrolách, pred eskaláciou. |
| Stránka procesu alebo kontrolného zoznamu | Niekedy; použite kroky pre usporiadanú časť vykonania a zaškrtávacie políčka pre nezávislé brány. | Medzi vstupmi procesu a jeho záverečným kontrolným zoznamom. |
| Obsah nastavenia produktu | Niekedy; použite ho, keď jeden stav produktu odomyká ďalší. | Po požiadavkách na prístup a pred potvrdením alebo ďalšími krokmi onboardingu. |
Frontmatter postTypes zaznamenáva tieto vzťahy na katalógové a validačné účely. Len registrované stránky typu príspevku z playbooku dostávajú odkazy; ostatné riadky opisujú podporované redakčné vzory bez vymýšľania ciest.
Kontrolný zoznam QA
Pred publikovaním overte všetky nasledujúce body:
- Výmena susedných krokov by zmenila, zablokovala alebo zneplatnila výsledok.
- Predpoklady uvádzajú každý požadovaný východiskový stav, oprávnenie, nástroj, zásobu a riziko.
- Postup obsahuje 3–10 krokov alebo dokumentuje odôvodnenú výnimku.
- Každý krok má imperatívny názov, dôvod, akciu, pozorovateľný stav úspechu a spôsob obnovy.
- Každý krok prináša jednu zmysluplnú zmenu stavu a zostáva v rámci jednej úrovne vnorenia.
- Akýkoľvek podpostup, ktorý má vlastné predpoklady alebo výsledok, bol oddelený.
- Snímky obrazovky sa objavujú len tam, kde je rozhranie alebo stav nejednoznačný, najviac jedna na krok.
- Blok výsledku uvádza, čo teraz existuje a čo môže čitateľ urobiť ďalej.
- Sémantika usporiadaného zoznamu, poradie nadpisov, fragmentové odkazy a alternatívny text fungujú bez farby alebo skriptovania.
- Vlastnosti
HowTo, ak sú prítomné, sa presne zhodujú s viditeľnými krokmi, poradím, trvaním, zásobami, nástrojmi, textom a obrázkami. - Mapovania pre Prenosný Markdown, Hugo a WordPress zachovávajú rovnaké polia a význam.
- Odkazy a metadáta prechádzajú širším kontrolným zoznamom QA pred publikovaním .
FAQ
Koľko krokov by mal obsahovať zoznam krokov? Použite 3–10. Umiestnite jeden alebo dva úkony do súvislého textu; zoskupte alebo rozdeľte viac ako desať.
Čo robí z číslovaného zoznamu skutočný zoznam krokov? Poradie musí ovplyvňovať výsledok a každý krok musí spĺňať päťčlennú zmluvu.
Potrebuje každý krok snímku obrazovky? Nie. Pridajte ju len vtedy, keď slová nedokážu spoľahlivo identifikovať rozhranie, umiestnenie alebo stav.
Môže krok obsahovať podkroky? Áno, na jednej úrovni. Oddeľte akúkoľvek postupnosť s vlastnými predpokladmi, výsledkom alebo viac ako tromi akciami.
Kedy by sa mal stať kontrolným zoznamom? Keď sa položky dajú dokončiť v ľubovoľnom poradí alebo sú nezávislými kontrolnými bránami.
Zoznam krokov je jedným z SEO obsahových prvkov , ktorý nesie správanie aj prezentáciu. Jeho kvalita je preukázaná, keď sa čitateľ dokáže zotaviť z zlyhania a stále dosiahnuť sľúbený výsledok — nie keď čísla len vyzerajú úhľadne.
Ďalšie návody v tejto sekcii
Pripravení uviesť to do praxe?
Bezplatná kontrola · 7-dňová skúška · bez platobnej karty