Seznamy kroků: Jak psát instrukce krok za krokem

Seznam kroků je uspořádaný postup, který čtenáře přenese ze známého výchozího stavu k ověřitelnému výsledku. Jeho čísla nesou význam: krok 2 závisí na kroku 1 a změna pořadí by mohla zmařit práci, způsobit chybu nebo zabránit dokončení. Každý krok vysvětluje více než jen kam kliknout. Poskytuje důvod, akci, stav úspěchu a postup zotavení potřebný k tomu, aby se čtenář mohl posunout dál.

1. Potvrďte, že změna pořadí mění výsledek. Proč: Číslování slibuje závislost, takže falešné pořadí uvádí čtenáře i stroje v omyl. Akce: Zkuste prohodit dvě akce. Úspěch: Alespoň jedna záměna by změnila, zablokovala nebo zneplatnila výsledek. Zotavení: Pokud každá akce stále funguje, nahraďte posloupnost odrážkami nebo kontrolním seznamem.

2. Napište pozorovatelný stav úspěchu. Proč: Čtenáři potřebují důkaz, že akce fungovala, než budou pokračovat. Akce: Pojmenujte, co mohou vidět, změřit, stáhnout nebo otestovat. Úspěch: Osoba neznalá návrhu by dokázala rozhodnout o úspěchu či selhání. Zotavení: Pokud úspěch závisí pouze na úsudku, přidejte konkrétní práh nebo příklad.

3. Přidejte postup zotavení pro případ selhání. Proč: Postup, který předpokládá dokonalé provedení, nechává čtenáře napospas při první chybě. Akce: Uveďte nejbezpečnější opravu, opakování nebo eskalaci. Úspěch: Čtenář se může vrátit do očekávaného stavu bez hádání. Zotavení: Pokud neexistuje bezpečné zotavení, varujte před akcí a určete, kdo může pomoci.

Tento živý příklad je záměrně stručný, přesto však plní závazek kroku. Zbytek této stránky definuje, jak prvek konzistentně vytvářet napříč publikačními systémy.

Proč na tomto prvku záleží

Čtenáři postupů chtějí vědět, co nyní dělat, proč na tom záleží, zda to fungovalo a co dělat, když se realita liší od ideální cesty. „Klikněte na Uložit" odpovídá pouze na první otázku. Nechává čtenáře hádat, jaké potvrzení očekávat a co znamená selhání.

Seznam kroků tuto nejistotu snižuje vytvořením opakovaného rozhodovacího rytmu. Imperativní název začíná příkazem jako „Připojte", „Ověřte" nebo „Publikujte". Důvod vytváří relevanci dříve, než čtenář investuje úsilí. Akce poskytuje dostatek podrobností k provedení. Stav úspěchu činí dokončení pozorovatelným. Postup zotavení zabraňuje tomu, aby se z neúspěšné akce stala slepá ulička. To je závazek kroku a každý viditelný krok musí splňovat všech pět částí.

Stejná pravidelnost zlepšuje strojovou extrahovatelnost: schopnost vyhledávače, AI agenta nebo transformačního systému izolovat instrukci, aniž by ztratila svou roli. Stabilní pořadí, popisné názvy, explicitní výsledky a ohraničené pokyny k zotavení umožňují stroji rozlišit instrukci od jejího ověření.

Čísla sama o sobě tento význam nevytvářejí. Odhalují význam, který obsah již má. Když je posloupnost skutečná, číslování komunikuje závislost skenujícímu čtenáři a zachovává pozici pro strukturovaná data. Když je posloupnost umělá, číslování vytváří falešný slib.

Kdy to použít

Použijte seznam kroků, když čtenář musí provést postup v určeném pořadí a každá dokončená akce vytváří výchozí stav pro další. Vhodné použití zahrnuje nastavení účtu, konfiguraci softwaru, opakovatelný analytický workflow, migraci, sekvenci oprav nebo publikační proces se závislostmi.

Nepoužívejte seznam kroků jen proto, že čísla vypadají autoritativně. Použijte odrážky, když jsou položky možnosti, příklady, ingredience nebo charakteristiky. Použijte kontrolní seznam, když jsou položky nezávislé brány, které lze ověřit v libovolném pořadí. Použijte srovnávací tabulku, když čtenář vybírá mezi alternativami, nikoli směřuje k jednomu výsledku. Použijte běžný souvislý text, když existuje pouze jedna nebo dvě zřejmé akce a ani jedna nepotřebuje nezávislé ověření.

Nejčastější zneužití způsobují hraniční případy:

• „Deset způsobů, jak vylepšit vstupní stránku" je seznamový článek, pokud položka 4 nevyžaduje výstup položky 3.
• „Před publikováním zkontrolujte název, odkazy, obrázky a autora" je kontrolní seznam, protože pořadí neurčuje platnost.
• „Vyberte plán, zadejte platební údaje a potvrďte nákup" je seznam kroků, protože každý stav odemyká další.
• „Pokud import selže, zkuste A, B nebo C" je návod k odstraňování problémů. Stává se seznamem kroků pouze tehdy, když musí být diagnostické větve vyzkoušeny v definovaném pořadí.
• Chronologie popisuje, co se stalo v průběhu času. Není to postup, pokud čtenář nemůže provést jeho akce k dosažení uvedeného výsledku.

Proveďte test záměny, kdykoli je záměr nejasný: prohoďte dvě sousední položky a zeptejte se, zda postup zůstává správný. Pokud je každá záměna neškodná, je řazení dekorativní a toto je špatný prvek.

Kam to umístit

Seznam kroků patří poté, co čtenář rozumí výsledku a má vstupy potřebné k zahájení. Umístěte blok předpokladů bezprostředně nad něj s uvedením výchozího stavu, oprávnění, souborů nebo dat, nástrojů, zásob, času a nevratných rizik. Vynechejte pole, která nejsou relevantní; nikdy neschovávejte požadovaný vstup do kroku 4.

Umístěte blok výsledku bezprostředně pod poslední krok. Uvádí dokončený stav, artefakt nebo stav, který by čtenář nyní měl mít, a další rozumnou akci. Tím se postup uzavírá, místo aby čtenář usuzoval, že absence dalšího čísla znamená úspěch.

Prvek se může objevit jednou jako hlavní postup na stránce návodu nebo několikrát jako jasně pojmenované fáze v delším tutoriálu. Nadpis fáze musí vysvětlovat mezivýsledek a číslování musí buď pokračovat napříč fázemi, nebo používat explicitní identifikátory jako „Fáze 2, krok 1." Nerestartujte tiše od 1.

Seznam kroků nesmí být umístěn přímo vedle jiného číslovaného seznamu s odlišným účelem; nadpis nebo přechod musí vysvětlovat hranici. Nesmí začínat před varováním, které mění, zda je úkol bezpečné provést. Neumísťujte obecnou výzvu k akci mezi kroky, nevhazujte odkazy mezi akci a její stav úspěchu ani nevkládejte nesouvisející srovnávací tabulku uprostřed postupu. Podpůrný materiál patří dovnitř relevantního kroku pouze tehdy, když pomáhá dokončit tuto akci; jinak jej umístěte před nebo za celou sekvenci.

Anatomie

Anatomie má tři oblasti na úrovni kolekce a pět opakujících se oblastí na úrovni kroku:

1. Předpoklady: výchozí stav, přístup, nástroje, zásoby, čas a důležitá omezení.
2. Označení sekvence: popisný nadpis, který pojmenovává postup a jeho výsledek.
3. Číslo kroku: sémantická pozice, generovaná rendererem uspořádaného seznamu, nikoli napsaná v názvu.
4. Imperativní název: jedna fráze vedená akcí, která skenujícímu čtenáři umožňuje odhadnout úkol.
5. Proč: závislost, riziko nebo přínos, který ospravedlňuje provedení kroku nyní.
6. Akce: přesná instrukce včetně relevantního umístění, vstupu a volby.
7. Úspěch a zotavení: pozorovatelný dokončený stav následovaný další bezpečnou reakcí, když se tento stav neobjeví.
8. Výsledek: konečný stav a to, co s ním čtenář může dělat.

Legenda zůstává na stránce, protože popisky jsou obsah, nikoli grafika. Pokud se design změní, stejné sémantické oblasti musí zůstat identifikovatelné bez úpravy pixelů.

Příklady designu

Výchozí varianta pokrývá většinu redakčních postupů. Kompaktní varianta může zmenšit mezery, ale nesmí odstranit pole závazku. Varianta s pomocí snímku obrazovky páruje nejednoznačný krok rozhraní s jedním zaměřeným obrázkem. Fázovaná varianta seskupuje dlouhý postup podle mezivýsledků při zachování soudržné celkové posloupnosti.

Žádná „minimální" varianta nesmí vynechat důvody nebo postupy zotavení. Prezentace může komprimovat bílé místo, nikoli redakční závazek.

Parametry

Tyto parametry definují zdrojový obsah, nikoli volitelnou vizuální dekoraci. Sloupec „Zdroj" ukazuje, zda hodnota pochází z atributu, těla vnořené položky nebo jejího prvního nadpisu.

Běžná délka na jeden krok je 50–140 slov napříč pěti poli závazku. Kratší kroky obvykle vynechávají zdůvodnění nebo ověření; delší kroky obvykle skrývají několik akcí.

Syntaxe a příklady kódu

Kanonická struktura se řídí pravidly psaní prvků : rodič obsahuje nastavení kolekce a každý opakovaný krok je vnořená položka. Příklady níže kódují stejný dvoukrokový fragment pro přehlednost mapování; publikovatelný postup by měl obvykle obsahovat alespoň tři kroky.

Přenosný Markdown direktiv

:::step-list{totalTime="PT15M" variant=default}
## Připojte a ověřte zdroj dat

Předpoklady: administrátorský přístup a identifikátor vlastnosti.

::item
### Otevřete obrazovku připojení vlastnosti

**Proč:** Spuštění ze správné vlastnosti zabrání připojení dat k nesprávnému účtu.

**Akce:** Otevřete Nastavení, zvolte Zdroje dat a vyberte identifikátor vlastnosti uvedený v bloku předpokladů.

**Úspěch:** Název vybrané vlastnosti se zobrazí v souhrnu připojení.

**Zotavení:** Pokud chybí, potvrďte přístup k účtu a znovu načtěte seznam vlastností.
::
::item
### Spusťte test připojení

**Proč:** Úspěšný test prokazuje, že přihlašovací údaje a oprávnění fungují před prvním importem.

**Akce:** Zvolte Testovat připojení a počkejte na odpověď o stavu.

**Úspěch:** Rozhraní zobrazí „Připojeno" s aktuálním časovým razítkem.

**Zotavení:** Proveďte opětovnou autorizaci účtu; pokud test stále selhává, zkopírujte chybový kód pro podporu.
::

Výsledek: zdroj je připojen a připraven k prvnímu importu.
:::

Mapování Hugo shortcode

{{< step-list totalTime="PT15M" variant="default" >}}
Předpoklady: administrátorský přístup a identifikátor vlastnosti.
{{< step title="Otevřete obrazovku připojení vlastnosti" >}}
**Proč:** Spuštění ze správné vlastnosti zabrání připojení dat k nesprávnému účtu.
**Akce:** Otevřete Nastavení, zvolte Zdroje dat a vyberte identifikátor vlastnosti.
**Úspěch:** Vybraná vlastnost se zobrazí v souhrnu připojení.
**Zotavení:** Potvrďte přístup a znovu načtěte seznam vlastností.
{{< /step >}}
{{< step title="Spusťte test připojení" >}}...{{< /step >}}
Výsledek: zdroj je připojen a připraven k prvnímu importu.
{{< /step-list >}}

Tento zápis definuje adaptérovou smlouvu; autoři musí používat registrovaný renderer webu, je-li k dispozici. Tato stránka vykresluje svůj živý příklad jako sémantický Markdown a nezavádí nový Hugo shortcode.

Mapování WordPress bloku

<!-- wp:amicited/step-list {"totalTime":"PT15M","variant":"default"} -->
<!-- wp:amicited/step {"title":"Otevřete obrazovku připojení vlastnosti"} -->
<p><strong>Proč:</strong> Spuštění ze správné vlastnosti zabrání připojení dat k nesprávnému účtu.</p>
<p><strong>Akce:</strong> Otevřete Nastavení, zvolte Zdroje dat a vyberte identifikátor vlastnosti.</p>
<p><strong>Úspěch:</strong> Vybraná vlastnost se zobrazí v souhrnu připojení.</p>
<p><strong>Zotavení:</strong> Potvrďte přístup a znovu načtěte seznam vlastností.</p>
<!-- /wp:amicited/step -->
<!-- /wp:amicited/step-list -->

Výstup platformy se může vizuálně lišit, ale každé pole a jeho význam musí zůstat zachovány.

Příklady

Dobře: ověřte doménu před sběrem dat

1. Přidejte záznam ověření. Proč: Záznam prokazuje kontrolu nad doménou bez odhalení přihlašovacích údajů k účtu. Akce: Zkopírujte přesnou TXT hodnotu do DNS nastavení domény a uložte ji u kořenového hostitele. Úspěch: Poskytovatel zobrazí záznam v seznamu DNS bez dalších uvozovek. Zotavení: Pokud chybí, zkontrolujte, zda pole hostitel používá kořenový symbol požadovaný poskytovatelem, a před opakováním počkejte na propagaci DNS.
2. Potvrďte vlastnictví v produktu. Proč: Potvrzení zabraňuje zahájení sběru dat na neověřené vlastnosti. Akce: Vraťte se na obrazovku ověření a zvolte Ověřit, jakmile je záznam veřejně rozlišitelný. Úspěch: Stav domény se změní na Ověřeno a zobrazí čas ověření. Zotavení: Pokud ověření selže, vyhledejte TXT záznam, porovnejte jej znak po znaku a opravte DNS záznam před dalším pokusem.
3. Spusťte první sběr. Proč: Ověřená, ale nečinná vlastnost nevytváří žádnou základní linii. Akce: Zvolte Spustit sběr a ponechte výchozí rozsah, pokud projekt nevyžaduje zdokumentovanou výjimku. Úspěch: Objeví se zařazená úloha s ověřenou doménou a aktuálním časem. Zotavení: Pokud se žádná úloha neobjeví, jednou obnovte stránku; poté zachyťte doménu, čas a chybovou zprávu pro podporu, místo abyste vytvářeli duplicity.

Toto funguje, protože pořadí je skutečné, názvy jsou imperativní, kontrolní body jsou viditelné a pokyny při selhání jsou bezpečné.

Špatně: vylepšete článek

1. Přidejte interní odkazy.
2. Přepište úvod.
3. Zkontrolujte pravopis.
4. Přidejte příklady.

Seznam je špatný ze dvou důvodů. Zaprvé, jeho pořadí je libovolné: pravopis lze zkontrolovat před odkazy a příklady lze přidat před úvod. Měl by to být kontrolní seznam. Zadruhé, každá položka pouze pojmenovává činnost. Žádná nevysvětluje, proč tam patří, jak daleko zajít, co se považuje za úspěch nebo co dělat, když kontrola selže. Přidání dalších sloves by sémantický nesoulad nevyřešilo.

Granularita a vnořování

Jeden krok by měl vytvořit jednu smysluplnou změnu stavu. Několik kliknutí může patřit do tohoto kroku, když tvoří jednu nepřerušenou interakci a sdílejí jeden signál úspěchu. Například „Zvolte CSV, vyberte UTF-8 a exportujte soubor" je jeden krok, pokud je pozorovatelným výsledkem stažený CSV. Rozdělte jej, když mezivýsledek vyžaduje ověření, jiné oprávnění, výrazné čekání, rozhodovací větev nebo odlišný postup zotavení.

Použijte test věty: pokud název potřebuje „a" ke spojení dvou výsledků, pravděpodobně obsahuje dva kroky. Použijte také test selhání: pokud první polovina může uspět, zatímco druhá selže a každá vyžaduje jiné zotavení, rozdělte je.

Vnořování je omezeno na jednu úroveň a tři krátké podkroky. Podkroky objasňují těsně ohraničenou akci; nevytvářejí postup uvnitř postupu. Povýšte sekvenci na vlastní stránku, když má samostatné předpoklady, více než tři akce, více snímků obrazovky, více než jednu větev selhání nebo výsledek, který může jiná stránka samostatně použít. Odkažte na tento podpostup, pak ponechte rodičovský krok zaměřený na to, kdy jej provést a jak potvrdit jeho výsledek.

Politika snímků obrazovky na krok

Snímek obrazovky si zaslouží své místo, když slova nedokážou spolehlivě identifikovat ovládací prvek nebo stav. Použijte jej, když jsou popisky duplikované, ovládací prvek je skrytý v nabídce, záleží na prostorovém umístění, rozhraní používá neznámou ikonu nebo je stav úspěchu vizuálně nejednoznačný. Ořízněte na oblast úkolu, zachovejte dostatek kontextu pro orientaci a popište relevantní stav v alternativním textu a blízké próze.

Vynechejte snímek obrazovky, když je popisek rozhraní jedinečný a stav úspěchu lze přesně uvést. Vynechejte také snímky rutinních akcí, jako je výběr jasně označeného tlačítka Uložit, příkazů terminálu již zobrazených jako text nebo každé obrazovky procházené na cestě k jedné smysluplné volbě. Čtrnáct snímků pro čtrnáct zřejmých kroků promění postup v pomalou, křehkou prezentaci a činí změny rozhraní nákladnými na údržbu.

Použijte nejvýše jeden snímek obrazovky na krok. Pokud krok potřebuje obrázky před, během a po, jeho granularita je pravděpodobně příliš široká. Nikdy neodkazujte na asset, dokud neexistuje, a nikdy neumísťujte zásadní instrukce pouze do obrázku.

Schema markup a přístupnost

Schema markup je strojově čitelný kód, který popisuje význam a vztahy viditelného obsahu. Když stránka skutečně vyučuje kompletní postup, může seznam kroků napájet objekt Schema.org HowTo vyjádřený jako JSON-LD . Mapování je přímé:

Markup musí přesně zrcadlit viditelný postup. Nikdy nepřidávejte skryté kroky, neslučujte dva viditelné kroky do jedné položky schématu, nepřesouvejte je ani nevynechávejte pokyny k zotavení, aby byla strukturovaná verze kratší. Neaplikujte HowTo pouze proto, že stránka obsahuje číslovaný seznam; stránka musí popisovat dokončitelný proces.

Přístupnost začíná u <ol> obsahujícího jedno <li> na krok. Číslo a pořadí musí zůstat k dispozici asistenčním technologiím. Nevkládejte čísla do nadpisů, protože zkopírovaný text, CSS čítače a výstup čteček obrazovky se mohou rozcházet. Používejte logické úrovně nadpisů, stabilní fragmentové identifikátory, popisné alternativy k snímkům a textové popisky pro úspěch a zotavení namísto pouhé barvy.

Vyhněte se interaktivním ovládacím prvkům, které mění pořadí kroků bez oznámení změny. Pokud se kroky sbalí, ovládací prvek potřebuje přístupný název a rozbalený stav a klávesnicové zaměření musí zůstat předvídatelné. Tisknutelný výstup a výstup bez JavaScriptu musí zachovat celý postup.

Pravidla psaní

Pište 3–10 kroků, obvykle 50–140 slov každý. Začněte každý název o 2–8 slovech imperativním slovesem a popište jeden výsledek. Vysvětlete důvod před akcí, kterou by čtenáři mohli přeskočit, přeskupit nebo nepochopit. Používejte klidný, přímý jazyk.

Každý krok musí obsahovat pět polí závazku, i když vykreslený design nemusí opakovat objemné popisky, pokud typografie zprostředkovává informace přístupně. Stav úspěchu musí být pozorovatelný: změní se stav, existuje soubor, hodnota spadá do uvedeného rozmezí, přijde e-mail nebo test projde. „Vše vypadá dobře" není pozorovatelné. Zotavení musí být bezpečné, konkrétní a přiměřené; odlišujte opakování od vracení změn a identifikujte eskalaci, když čtenář nemůže stav opravit.

Neumísťujte do kroku nesouvisející pozadí, propagační výzvy k akci, reference, druhý nezávislý postup nebo několik rozhodovacích větví. Přesuňte pozadí nad seznam, propagaci pod výsledek a rozsáhlé větve do sekcí pro odstraňování problémů. Nepoužívejte „jednoduše", „samozřejmě" nebo „stačí" pro akci, která může selhat. Nikdy neslibujte obrazovku, popisek, čas nebo výsledek, který produkt skutečně neposkytuje.

Typy příspěvků, které jej používají

Pole postTypes ve frontmatter zaznamenává tyto vztahy pro katalogové a validační účely. Pouze registrované playbook stránky typů příspěvků obdrží odkazy; ostatní řádky popisují podporované redakční vzory bez vymýšlení tras.

Kontrolní seznam QA

Před publikováním ověřte všechny následující body:

• Prohození sousedních kroků by změnilo, zablokovalo nebo zneplatnilo výsledek.
• Předpoklady uvádějí každý požadovaný výchozí stav, oprávnění, nástroj, zásobu a riziko.
• Postup obsahuje 3–10 kroků nebo dokumentuje odůvodněnou výjimku.
• Každý krok má imperativní název, důvod, akci, pozorovatelný stav úspěchu a postup zotavení.
• Každý krok vytváří jednu smysluplnou změnu stavu a zůstává v jedné úrovni vnoření.
• Jakýkoli podpostup, který má vlastní předpoklady nebo výsledek, byl oddělen.
• Snímky obrazovky se objevují pouze tam, kde je rozhraní nebo stav nejednoznačný, a to nejvýše jeden na krok.
• Blok výsledku uvádí, co nyní existuje a co může čtenář udělat dále.
• Sémantika uspořádaného seznamu, pořadí nadpisů, fragmentové odkazy a alternativní text fungují bez barev nebo skriptování.
• Vlastnosti HowTo, jsou-li přítomny, se přesně shodují s viditelnými kroky, pořadím, dobou trvání, zásobami, nástroji, textem a obrázky.
• Přenosné Markdown, Hugo a WordPress mapování zachovávají stejná pole a význam.
• Odkazy a metadata procházejí širším předpublikačním kontrolním seznamem QA .

FAQ

Kolik kroků by měl seznam kroků obsahovat? Použijte 3–10. Dejte jednu nebo dvě akce do prózy; seskupte nebo rozdělte více než deset.

Co dělá z číslovaného seznamu skutečný seznam kroků? Pořadí musí ovlivňovat výsledek a každý krok musí splňovat pětidílný závazek.

Potřebuje každý krok snímek obrazovky? Ne. Přidejte jej pouze tehdy, když slova nedokážou spolehlivě identifikovat rozhraní, umístění nebo stav.

Může krok obsahovat podkroky? Ano, na jedné úrovni. Oddělte jakoukoli sekvenci s vlastními předpoklady, výsledkem nebo více než třemi akcemi.

Kdy by se měl stát kontrolním seznamem? Když lze položky dokončit v libovolném pořadí nebo jsou nezávislými kontrolními branami.

Seznam kroků je jedním z SEO obsahových prvků , který nese chování i prezentaci. Jeho kvalita je prokázána, když se čtenář dokáže zotavit z neúspěchu a přesto dosáhnout slíbeného výsledku – ne když čísla pouze vypadají úhledně.