Listy kroków: jak pisać instrukcje krok po kroku
Twórz listy kroków, które wyjaśniają każdą czynność, jej cel, sygnał powodzenia i ścieżkę odzyskiwania, aby ludzie i maszyny mogli z ufnością podążać za instrukcjami.
Lista kroków to uporządkowana procedura, która prowadzi czytelnika od znanego stanu początkowego do weryfikowalnego rezultatu. Jej liczby niosą znaczenie: krok 2 zależy od kroku 1, a zmiana kolejności może zmarnować pracę, spowodować błąd lub uniemożliwić ukończenie. Każdy krok wyjaśnia więcej niż tylko gdzie kliknąć. Podaje powód, czynność, stan powodzenia i ścieżkę odzyskiwania potrzebne do kontynuowania.
Potwierdź, że zmiana kolejności wpływa na wynik. Dlaczego: Numeracja obiecuje zależność, więc fałszywa kolejność wprowadza w błąd czytelników i maszyny. Czynność: Spróbuj zamienić dwie czynności miejscami. Powodzenie: Co najmniej jedna zamiana zmieni, zablokuje lub unieważni wynik. Odzyskiwanie: Jeśli każda czynność nadal działa, zastąp sekwencję wypunktowaniem lub listą kontrolną.
Opisz obserwowalny stan powodzenia. Dlaczego: Czytelnicy potrzebują dowodu, że czynność zadziałała, zanim przejdą dalej. Czynność: Określ, co mogą zobaczyć, zmierzyć, pobrać lub przetestować. Powodzenie: Osoba nieznająca szkicu mogłaby stwierdzić, czy test przeszedł, czy nie. Odzyskiwanie: Jeśli powodzenie zależy wyłącznie od oceny, dodaj konkretny próg lub przykład.
Dodaj ścieżkę odzyskiwania na wypadek niepowodzenia. Dlaczego: Procedura zakładająca idealne wykonanie porzuca czytelnika przy pierwszym błędzie. Czynność: Określ najbezpieczniejszą korektę, ponowienie próby lub eskalację. Powodzenie: Czytelnik może wrócić do oczekiwanego stanu bez zgadywania. Odzyskiwanie: Jeśli nie ma bezpiecznej ścieżki odzyskiwania, ostrzeż przed czynnością i wskaż, kto może pomóc.
Ten żywy przykład jest celowo zwięzły, ale wciąż spełnia umowę kroku. Reszta tej strony definiuje, jak tworzyć element w sposób spójny w różnych systemach publikacyjnych.
Dlaczego ten element jest ważny
Czytelnicy proceduralni chcą wiedzieć, co robić teraz, dlaczego to ważne, czy zadziałało i co robić, gdy rzeczywistość odbiega od ścieżki sukcesu. „Kliknij Zapisz” odpowiada tylko na pierwsze pytanie. Pozostawia czytelnikowi domyślanie się, jakiego potwierdzenia oczekiwać i co oznacza porażka.
Lista kroków zmniejsza tę niepewność, tworząc powtarzalny rytm decyzyjny. Tytuł w trybie rozkazującym zaczyna się od polecenia, takiego jak „Połącz”, „Zweryfikuj” lub „Opublikuj”. Powód ustanawia znaczenie, zanim czytelnik zainwestuje wysiłek. Czynność dostarcza wystarczająco dużo szczegółów, aby wykonać zadanie. Stan powodzenia czyni ukończenie obserwowalnym. Ścieżka odzyskiwania zapobiega, by nieudana czynność stała się ślepą uliczką. To jest umowa kroku, a każdy widoczny krok musi spełniać wszystkie pięć części.
Ta sama regularność poprawia maszynową ekstrahowalność: zdolność wyszukiwarki, agenta AI lub systemu transformacji do wyizolowania instrukcji bez utraty jej roli. Stabilna kolejność, opisowe tytuły, jawne wyniki i ograniczone wskazówki dotyczące odzyskiwania pozwalają maszynie odróżnić instrukcję od jej weryfikacji.
Liczby same w sobie nie tworzą tego znaczenia. Ujawniają znaczenie, które treść już ma. Gdy sekwencja jest autentyczna, numeracja komunikuje zależność skanującemu czytelnikowi i zachowuje pozycję dla danych strukturalnych. Gdy sekwencja jest sztuczna, numeracja tworzy fałszywą obietnicę.
Kiedy go używać
Używaj listy kroków, gdy czytelnik musi wykonać procedurę w określonej kolejności, a każda ukończona czynność ustanawia stan początkowy dla następnej. Odpowiednie zastosowania obejmują konfigurację konta, konfigurację oprogramowania, powtarzalny przepływ analizy, migrację, sekwencję naprawy lub proces publikacji z zależnościami.
Nie używaj listy kroków tylko dlatego, że liczby wyglądają autorytatywnie. Używaj wypunktowania, gdy elementy są opcjami, przykładami, składnikami lub cechami. Używaj listy kontrolnej, gdy elementy są niezależnymi punktami, które można zweryfikować w dowolnej kolejności. Używaj tabeli porównawczej, gdy czytelnik wybiera między alternatywami, a nie zmierza do jednego rezultatu. Używaj zwykłego tekstu ciągłego, gdy są tylko jedna lub dwie oczywiste czynności i żadna nie wymaga niezależnej weryfikacji.
Przypadki graniczne powodują najwięcej błędów:
- „Dziesięć sposobów na poprawę strony docelowej” to artykuł w formie listy, chyba że pozycja 4 wymaga wyniku pozycji 3.
- „Przed publikacją sprawdź tytuł, linki, obrazy i autora” to lista kontrolna, ponieważ kolejność nie decyduje o poprawności.
- „Wybierz plan, wprowadź dane płatności i potwierdź zakup” to lista kroków, ponieważ każdy stan odblokowuje następny.
- „Jeśli import się nie powiedzie, spróbuj A, B lub C” to wskazówki dotyczące rozwiązywania problemów. Staje się listą kroków tylko wtedy, gdy gałęzie diagnostyczne muszą być wypróbowane w określonej kolejności.
- Chronologia opisuje, co wydarzyło się w czasie. Nie jest procedurą, chyba że czytelnik może wykonać jej czynności, aby osiągnąć określony rezultat.
Wykonaj test zamiany, gdy intencja jest niejasna: zamień miejscami dwa sąsiednie elementy i zapytaj, czy procedura pozostaje poprawna. Jeśli każda zamiana jest nieszkodliwa, kolejność jest dekoracyjna i jest to niewłaściwy element.
Gdzie go umieścić
Lista kroków znajduje się po tym, jak czytelnik zrozumie rezultat i ma dane wejściowe potrzebne do rozpoczęcia. Umieść blok wymagań wstępnych bezpośrednio nad nią, określając stan początkowy, uprawnienia, pliki lub dane, narzędzia, materiały, czas i nieodwracalne ryzyka. Pomiń pola, które nie mają zastosowania; nigdy nie ukrywaj wymaganego wejścia w kroku 4.
Umieść blok rezultatu bezpośrednio pod ostatnim krokiem. Określa on stan ukończenia, artefakt lub stan, który czytelnik powinien teraz mieć, oraz następną sensowną czynność. To zamyka procedurę, zamiast pozostawiać czytelnikowi domyślanie się, że brak kolejnego numeru oznacza sukces.
Element może wystąpić raz jako główna procedura na stronie poradnika lub kilka razy jako wyraźnie nazwane fazy w dłuższym samouczku. Nagłówek fazy musi wyjaśniać pośredni rezultat, a numeracja musi albo kontynuować się między fazami, albo używać jawnych identyfikatorów, takich jak „Faza 2, krok 1.” Nie zaczynaj po cichu od 1.
Lista kroków nie może znajdować się bezpośrednio obok innej ponumerowanej listy o innym przeznaczeniu; nagłówek lub przejście musi wyjaśniać granicę. Nie może zaczynać się przed ostrzeżeniem, które zmienia, czy zadanie jest bezpieczne do wykonania. Nie umieszczaj ogólnego wezwania do działania między krokami, nie wstawiaj odniesień między czynnością a jej stanem powodzenia ani nie wstawiaj niepowiązanej tabeli porównawczej w środku procedury. Materiały pomocnicze należą wewnątrz odpowiedniego kroku tylko wtedy, gdy pomagają ukończyć tę czynność; w przeciwnym razie umieść je przed lub po całej sekwencji.
Anatomia
Anatomia ma trzy regiony na poziomie kolekcji i pięć powtarzających się regionów na poziomie kroku:
- Wymagania wstępne: stan początkowy, dostęp, narzędzia, materiały, czas i ważne ograniczenia.
- Etykieta sekwencji: opisowy nagłówek, który nazywa procedurę i jej rezultat.
- Numer kroku: pozycja semantyczna, generowana przez renderer list uporządkowanych, a nie wpisywana w tytule.
- Tytuł w trybie rozkazującym: jedno zdanie prowadzone przez czynność, które pozwala skanującemu przewidzieć zadanie.
- Dlaczego: zależność, ryzyko lub korzyść uzasadniające wykonanie kroku teraz.
- Czynność: dokładna instrukcja, w tym odpowiednia lokalizacja, dane wejściowe i wybór.
- Powodzenie i odzyskiwanie: obserwowalny stan ukończenia, a następnie następna bezpieczna reakcja, gdy ten stan się nie pojawi.
- Rezultat: stan końcowy i co czytelnik może z nim zrobić.
Legenda pozostaje na stronie, ponieważ etykiety są treścią, a nie grafiką. Jeśli projekt się zmieni, te same regiony semantyczne muszą pozostać rozpoznawalne bez edycji pikseli.
Przykłady projektowe
Domyślny wariant obsługuje większość procedur redakcyjnych. Kompaktowy wariant może zmniejszyć odstępy, ale nie może usuwać pól umowy. Wariant ze zrzutami ekranu łączy niejednoznaczny krok interfejsu z jednym skupionym obrazem. Wariant fazowany grupuje długą procedurę według pośrednich rezultatów, zachowując spójną ogólną sekwencję.
Żaden wariant „minimalny” nie może pomijać powodów ani ścieżek odzyskiwania. Prezentacja może kompresować odstępy, ale nie umowę redakcyjną.
Parametry
Te parametry definiują źródłową treść, a nie opcjonalną dekorację wizualną. Kolumna źródło pokazuje, czy wartość pochodzi z atrybutu, treści zagnieżdżonego elementu czy jego pierwszego nagłówka.
| Nazwa | Typ | Wymagane | Min/maks | Domyślne | Źródło | |
|---|---|---|---|---|---|---|
title | Ciąg znaków | Tak | 3–10 słów | Brak | Pierwszy nagłówek w treści nadrzędnej | |
variant | Enum | Nie | default, compact lub phased | default | Atrybut nadrzędny | |
totalTime | Czas trwania ISO 8601 | Nie | 1 minuta do 30 dni | Pominięte | Atrybut nadrzędny, wspierany przez widoczny tekst czasu | |
prerequisites | Blok Markdown | Tak, gdy istnieją jakiekolwiek wymagania | 1–6 elementów; 10–120 słów | Pominięte tylko gdy żadne nie istnieją | Treść nadrzędna przed elementami | |
steps | Kolekcja uporządkowanych elementów | Tak | 3–10 kroków | Brak; docelowo 5 | Zagnieżdżone treści elementów | |
step.title | Ciąg znaków | Tak | 2–8 słów; 60 znaków | Brak | Pierwszy nagłówek w treści elementu | |
step.why | Zwykły Markdown | Tak | 10–35 słów | Brak | Treść elementu | |
step.action | Zwykły Markdown | Tak | 15–70 słów | Brak | Treść elementu | |
step.success | Zwykły Markdown | Tak | 8–30 słów | Brak | Treść elementu | |
step.recovery | Zwykły Markdown | Tak | 8–40 słów | Brak | Treść elementu | |
step.image | Ścieżka zasobu względna do katalogu głównego | Nie | 0–1 obraz na krok | Pominięte | Atrybut elementu; tylko gdy zasób istnieje | |
supply | Kolekcja ciągów znaków | Nie | 0–8 widocznych elementów | Pominięte | Wymagania wstępne w treści nadrzędnej | |
tool | Kolekcja ciągów znaków | Nie | 0–8 widocznych elementów | Pominięte | Wymagania wstępne w treści nadrzędnej | |
outcome | Blok Markdown | Tak | 15–80 słów | Brak | Treść nadrzędna po elementach |
Normalna długość na krok wynosi 50–140 słów w pięciu polach umowy. Krótsze kroki zwykle pomijają uzasadnienie lub weryfikację; dłuższe kroki zwykle ukrywają kilka czynności.
Składnia i przykłady kodu
Kanoniczna struktura jest zgodna z zasadami pisania elementów : element nadrzędny zawiera ustawienia kolekcji, a każdy powtarzany krok jest zagnieżdżonym elementem. Przykłady poniżej kodują ten sam dwukrokowy fragment dla przejrzystości mapowania; publikowalna procedura powinna normalnie zawierać co najmniej trzy kroki.
Przenośna dyrektywa Markdown
:::step-list{totalTime="PT15M" variant=default}
## Połącz i zweryfikuj źródło danych
Wymagania wstępne: dostęp administratora i identyfikator właściwości.
::item
### Otwórz ekran połączenia właściwości
**Dlaczego:** Rozpoczęcie od właściwej właściwości zapobiega przypisaniu danych do niewłaściwego konta.
**Czynność:** Otwórz Ustawienia, wybierz Źródła danych i wybierz identyfikator właściwości pokazany w bloku wymagań wstępnych.
**Powodzenie:** Wybrana nazwa właściwości pojawia się w podsumowaniu połączenia.
**Odzyskiwanie:** Jeśli jej brakuje, potwierdź dostęp do konta i odśwież listę właściwości.
::
::item
### Uruchom test połączenia
**Dlaczego:** Udany test dowodzi, że dane uwierzytelniające i uprawnienia działają przed pierwszym importem.
**Czynność:** Wybierz Testuj połączenie i poczekaj na odpowiedź statusu.
**Powodzenie:** Interfejs wyświetla „Połączono” z bieżącym znacznikiem czasu.
**Odzyskiwanie:** Ponownie autoryzuj konto; jeśli test nadal się nie powiedzie, skopiuj kod błędu dla wsparcia technicznego.
::
Rezultat: źródło jest połączone i gotowe do pierwszego importu.
:::
Mapowanie shortcode Hugo
{{< step-list totalTime="PT15M" variant="default" >}}
Wymagania wstępne: dostęp administratora i identyfikator właściwości.
{{< step title="Otwórz ekran połączenia właściwości" >}}
**Dlaczego:** Rozpoczęcie od właściwej właściwości zapobiega przypisaniu danych do niewłaściwego konta.
**Czynność:** Otwórz Ustawienia, wybierz Źródła danych i wybierz identyfikator właściwości.
**Powodzenie:** Wybrana właściwość pojawia się w podsumowaniu połączenia.
**Odzyskiwanie:** Potwierdź dostęp i odśwież listę właściwości.
{{< /step >}}
{{< step title="Uruchom test połączenia" >}}...{{< /step >}}
Rezultat: źródło jest połączone i gotowe do pierwszego importu.
{{< /step-list >}}
Ten zapis określa kontrakt adaptera; autorzy muszą używać zarejestrowanego renderera strony, gdy jest dostępny. Ta strona renderuje swój żywy przykład jako semantyczny Markdown i nie wprowadza nowego shortcode Hugo.
Mapowanie bloku WordPress
<!-- wp:amicited/step-list {"totalTime":"PT15M","variant":"default"} -->
<!-- wp:amicited/step {"title":"Otwórz ekran połączenia właściwości"} -->
<p><strong>Dlaczego:</strong> Rozpoczęcie od właściwej właściwości zapobiega przypisaniu danych do niewłaściwego konta.</p>
<p><strong>Czynność:</strong> Otwórz Ustawienia, wybierz Źródła danych i wybierz identyfikator właściwości.</p>
<p><strong>Powodzenie:</strong> Wybrana właściwość pojawia się w podsumowaniu połączenia.</p>
<p><strong>Odzyskiwanie:</strong> Potwierdź dostęp i odśwież listę właściwości.</p>
<!-- /wp:amicited/step -->
<!-- /wp:amicited/step-list -->
Wynik platformy może różnić się wizualnie, ale każde pole i jego znaczenie muszą zostać zachowane.
Przykłady
Dobrze: zweryfikuj domenę przed zbieraniem danych
- Dodaj rekord weryfikacyjny. Dlaczego: Rekord dowodzi kontroli nad domeną bez ujawniania danych uwierzytelniających konto. Czynność: Skopiuj dokładną wartość TXT do ustawień DNS domeny i zapisz ją na hoście głównym. Powodzenie: Dostawca pokazuje rekord na swojej liście DNS bez dodatkowych cudzysłowów. Odzyskiwanie: Jeśli go brakuje, sprawdź, czy pole hosta używa symbolu głównego wymaganego przez dostawcę i poczekaj na propagację DNS przed ponowną próbą.
- Potwierdź własność w produkcie. Dlaczego: Potwierdzenie zapobiega rozpoczęciu zbierania danych dla niezweryfikowanej właściwości. Czynność: Wróć do ekranu weryfikacji i wybierz Zweryfikuj, gdy rekord jest publicznie rozwiązywalny. Powodzenie: Status domeny zmienia się na Zweryfikowana i pokazuje czas weryfikacji. Odzyskiwanie: Jeśli weryfikacja się nie powiedzie, zapytaj o rekord TXT, porównaj go znak po znaku i popraw wpis DNS przed kolejną próbą.
- Rozpocznij pierwszą kolekcję. Dlaczego: Zweryfikowana, ale nieaktywna właściwość nie generuje danych bazowych. Czynność: Wybierz Rozpocznij kolekcję i zachowaj domyślny zakres, chyba że projekt wymaga udokumentowanego wykluczenia. Powodzenie: Pojawia się zadanie w kolejce ze zweryfikowaną domeną i bieżącym czasem. Odzyskiwanie: Jeśli zadanie się nie pojawi, odśwież raz; następnie przechwyć domenę, czas i komunikat błędu dla wsparcia technicznego, zamiast tworzyć duplikaty.
To działa, ponieważ kolejność jest rzeczywista, tytuły są w trybie rozkazującym, punkty kontrolne są widoczne, a wskazówki dotyczące niepowodzenia są bezpieczne.
Źle: ulepsz artykuł
- Dodaj linki wewnętrzne.
- Przepisz wstęp.
- Sprawdź pisownię.
- Dodaj przykłady.
Lista jest zła z dwóch powodów. Po pierwsze, jej kolejność jest arbitralna: pisownię można sprawdzić przed linkami, a przykłady można dodać przed wstępem. Powinna to być lista kontrolna. Po drugie, każdy element tylko nazywa czynność. Żaden nie wyjaśnia, dlaczego należy, jak daleko się posunąć, co liczy się jako sukces ani co robić, gdy kontrola się nie powiedzie. Dodanie większej liczby czasowników nie naprawiłoby semantycznego niedopasowania.
Szczegółowość i zagnieżdżanie
Jeden krok powinien powodować jedną znaczącą zmianę stanu. Kilka kliknięć może należeć do tego kroku, gdy tworzą jedną nieprzerwaną interakcję i dzielą jeden sygnał powodzenia. Na przykład „Wybierz CSV, wybierz UTF-8 i wyeksportuj plik” to jeden krok, jeśli obserwowalnym rezultatem jest pobrany plik CSV. Podziel go, gdy pośredni rezultat wymaga weryfikacji, innych uprawnień, znaczącego oczekiwania, rozgałęzienia decyzyjnego lub odrębnej ścieżki odzyskiwania.
Użyj testu zdania: jeśli tytuł potrzebuje „i”, aby połączyć dwa rezultaty, prawdopodobnie zawiera dwa kroki. Użyj też testu niepowodzenia: jeśli pierwsza połowa może się udać, podczas gdy druga się nie powiedzie, a każda wymaga innego odzyskiwania, podziel je.
Zagnieżdżanie jest ograniczone do jednego poziomu i trzech krótkich podkroków. Podkroki wyjaśniają ściśle ograniczoną czynność; nie tworzą procedury wewnątrz procedury. Promuj sekwencję do własnej strony, gdy ma oddzielne wymagania wstępne, więcej niż trzy czynności, wiele zrzutów ekranu, więcej niż jedną gałąź niepowodzenia lub rezultat, z którego inna strona mogłaby niezależnie skorzystać. Linkuj do tej podprocedury, a następnie utrzymuj krok nadrzędny skoncentrowany na tym, kiedy go wykonać i jak potwierdzić jego wynik.
Zasady dotyczące zrzutów ekranu na krok
Zrzut ekranu zasługuje na swoje miejsce, gdy słowa nie są w stanie wiarygodnie zidentyfikować elementu sterującego lub stanu. Użyj go, gdy etykiety są zduplikowane, element sterujący jest ukryty w menu, pozycja przestrzenna ma znaczenie, interfejs używa nieznanej ikony lub stan powodzenia jest wizualnie niejednoznaczny. Przytnij do obszaru zadania, zachowaj wystarczająco dużo kontekstu do orientacji i opisz odpowiedni stanie w tekście alternatywnym i pobliskim tekście.
Pomiń zrzut ekranu, gdy etykieta interfejsu jest unikalna, a stan powodzenia można dokładnie określić. Pomiń także zrzuty ekranu rutynowych czynności, takich jak wybór wyraźnie oznaczonego przycisku Zapisz, poleceń terminala już pokazanych jako tekst lub każdego ekranu mijającego w drodze do jednego znaczącego wyboru. Czternaście zrzutów ekranu dla czternastu oczywistych kroków zamienia procedurę w powolną, kruchą prezentację slajdów i sprawia, że zmiany interfejsu są kosztowne w utrzymaniu.
Używaj nie więcej niż jednego zrzutu ekranu na krok. Jeśli krok potrzebuje obrazów przed, w trakcie i po, jego szczegółowość jest prawdopodobnie zbyt szeroka. Nigdy nie odwołuj się do zasobu, dopóki nie istnieje, i nigdy nie umieszczaj istotnych instrukcji wyłącznie wewnątrz obrazu.
Znaczniki schematów i dostępność
Znaczniki schematów
to maszynowo czytelny kod opisujący znaczenie i relacje widocznej treści. Gdy strona rzeczywiście uczy pełnej procedury, lista kroków może zasilać obiekt HowTo schema.org wyrażony jako JSON-LD
. Mapowanie jest bezpośrednie:
| Widoczne pole | Właściwość HowTo | Zasada |
|---|---|---|
| Tytuł procedury | HowTo.name | Zgodny z widocznym nagłówkiem procedury. |
| Widoczny czas trwania | HowTo.totalTime | Zakoduj jako czas trwania ISO 8601, np. PT15M; nie wymyślaj czasu trwania tylko dla znaczników. |
| Wymagane materiały | HowTo.supply / HowToSupply | Uwzględnij tylko materiały eksploatacyjne wymienione w wymaganiach wstępnych. |
| Wymagane narzędzia | HowTo.tool / HowToTool | Uwzględnij tylko narzędzia wymienione w wymaganiach wstępnych. |
| Uporządkowane widoczne kroki | HowTo.step / HowToStep | Zachowaj dokładnie liczbę i kolejność. |
| Tytuł w trybie rozkazującym | HowToStep.name | Zgodny z widocznym tytułem kroku. |
| Dlaczego, czynność, powodzenie, odzyskiwanie | HowToStep.text | Zachowaj całe widoczne znaczenie instruktażowe, nie tylko czynność kliknięcia. |
| Obraz kroku | HowToStep.image | Uwzględnij tylko widoczny obraz dołączony do tego kroku. |
| Kotwica kroku | HowToStep.url | Wskazuj na stabilny identyfikator fragmentu widocznego kroku. |
Znaczniki muszą dokładnie odzwierciedlać widoczną procedurę. Nigdy nie dodawaj ukrytych kroków, nie łącz dwóch widocznych kroków w jeden element schematu, nie zmieniaj ich kolejności ani nie pomijaj wskazówek odzyskiwania, aby skrócić wersję strukturalną. Nie stosuj HowTo tylko dlatego, że strona zawiera ponumerowaną listę; strona musi opisywać proces, który można ukończyć.
Dostępność zaczyna się od <ol> zawierającego jeden <li> na krok. Numer i kolejność muszą pozostać dostępne dla technologii asystujących. Nie wpisuj liczb w nagłówki, ponieważ skopiowany tekst, liczniki CSS i wyjście czytnika ekranu mogą być rozbieżne. Używaj logicznych poziomów nagłówków, stabilnych identyfikatorów fragmentów, opisowych alternatyw dla zrzutów ekranu oraz etykiet tekstowych dla powodzenia i odzyskiwania, a nie tylko koloru.
Unikaj interaktywnych elementów sterujących, które zmieniają kolejność kroków bez informowania o zmianie. Jeśli kroki można zwijać, element sterujący potrzebuje dostępnej nazwy i stanu rozwinięcia, a fokus klawiatury musi pozostać przewidywalny. Wydruk i wyjście bez JavaScript musi zachować całą procedurę.
Zasady pisania
Pisz 3–10 kroków, normalnie 50–140 słów każdy. Rozpoczynaj każdy 2–8-wyrazowy tytuł od czasownika w trybie rozkazującym i opisuj jeden rezultat. Wyjaśniaj powód przed czynnością, którą czytelnicy mogliby pominąć, zmienić kolejność lub źle zrozumieć. Używaj spokojnego, bezpośredniego języka.
Każdy krok musi zawierać pięć pól umowy, choć renderowany projekt nie musi powtarzać obszernych etykiet, gdy typografia przekazuje je w sposób dostępny. Stan powodzenia musi być obserwowalny: zmienia się status, plik istnieje, wartość mieści się w określonym zakresie, przychodzi e-mail lub test przechodzi. „Wszystko wygląda dobrze” nie jest obserwowalne. Odzyskiwanie musi być bezpieczne, konkretne i proporcjonalne; odróżniaj ponawianie od cofania i identyfikuj eskalację, gdy czytelnik nie może naprawić stanu.
Nie umieszczaj niepowiązanego tła, promocyjnych wezwań do działania, referencji, drugiej niezależnej procedury ani kilku gałęzi decyzyjnych wewnątrz kroku. Przenieś tło nad listę, promocję pod rezultat, a znaczące gałęzie do sekcji rozwiązywania problemów. Nie używaj „po prostu”, „oczywiście” ani „wystarczy” w przypadku czynności, która może się nie udać. Nigdy nie obiecuj ekranu, etykiety, czasu ani wyniku, którego produkt faktycznie nie zapewnia.
Typy postów, które go używają
| Typ postu | Użycie | Pozycja |
|---|---|---|
| Poradnik | Zawsze; uporządkowana procedura jest główną obietnicą strony. | Po wymaganiach wstępnych, a przed rezultatem, rozwiązywaniem problemów i następną czynnością. |
| Samouczek | Zwykle; używaj go dla każdej fazy kierowanej zależnościami, nie do nauczania koncepcyjnego. | Po koncepcie potrzebnym dla fazy, a przed weryfikacją fazy. |
| Strona rozwiązywania problemów | Czasami; tylko gdy diagnozy lub naprawy muszą być wykonywane w bezpiecznej kolejności. | Po objawie i kontrolach bezpieczeństwa, przed eskalacją. |
| Strona procesu lub listy kontrolnej | Czasami; używaj kroków dla uporządkowanej części wykonawczej i pól wyboru dla niezależnych punktów. | Między danymi wejściowymi procesu a jego końcową listą kontrolną przeglądu. |
| Treść konfiguracji produktu | Czasami; używaj, gdy jeden stan produktu odblokowuje następny. | Po wymaganiach dostępu, a przed potwierdzeniem lub kolejnymi krokami wdrożenia. |
Frontmatter postTypes rejestruje te relacje do użytku w katalogu i walidacji. Tylko zarejestrowane strony typów postów playbooka otrzymują linki; pozostałe wiersze opisują wspierane wzorce redakcyjne bez wymyślania ścieżek.
Lista kontrolna QA
Przed publikacją zweryfikuj wszystkie poniższe punkty:
- Zamiana sąsiednich kroków miejscami zmieniłaby, zablokowała lub unieważniła wynik.
- Wymagania wstępne określają każdy wymagany stan początkowy, uprawnienia, narzędzia, materiały i ryzyko.
- Procedura zawiera 3–10 kroków lub dokumentuje uzasadniony wyjątek.
- Każdy krok ma tytuł w trybie rozkazującym, powód, czynność, obserwowalny stan powodzenia i ścieżkę odzyskiwania.
- Każdy krok powoduje jedną znaczącą zmianę stanu i pozostaje w obrębie jednego poziomu zagnieżdżenia.
- Każda podprocedura, która ma własne wymagania wstępne lub rezultat, została wydzielona.
- Zrzuty ekranu pojawiają się tylko tam, gdzie interfejs lub stan jest niejednoznaczny, nie więcej niż jeden na krok.
- Blok rezultatu określa, co teraz istnieje i co czytelnik może zrobić dalej.
- Semantyka list uporządkowanych, kolejność nagłówków, linki fragmentów i tekst alternatywny działają bez koloru ani skryptów.
- Właściwości
HowTo, gdy występują, dokładnie odpowiadają widocznym krokom, kolejności, czasowi trwania, materiałom, narzędziom, tekstowi i obrazom. - Mapowania przenośnego Markdown, Hugo i WordPress zachowują te same pola i znaczenie.
- Linki i metadane przechodzą szerszą listę kontrolną QA przed publikacją .
FAQ
Ile kroków powinna zawierać lista kroków? Używaj 3–10. Umieść jedną lub dwie czynności w tekście ciągłym; grupuj lub dziel więcej niż dziesięć.
Co sprawia, że ponumerowana lista jest prawdziwą listą kroków? Kolejność musi wpływać na wynik, a każdy krok musi spełniać pięcioczęściową umowę.
Czy każdy krok wymaga zrzutu ekranu? Nie. Dodaj go tylko wtedy, gdy słowa nie mogą wiarygodnie zidentyfikować interfejsu, lokalizacji lub stanu.
Czy krok może zawierać podkroki? Tak, na jednym poziomie. Wydziel każdą sekwencję z własnymi wymaganiami wstępnymi, rezultatem lub więcej niż trzema czynnościami.
Kiedy powinna stać się listą kontrolną? Gdy elementy można wykonać w dowolnej kolejności lub są niezależnymi punktami weryfikacji.
Lista kroków jest jednym z elementów treści SEO , który niesie zarówno zachowanie, jak i prezentację. Jej jakość jest potwierdzona, gdy czytelnik może odzyskać się po niepowodzeniu i nadal osiągnąć obiecany rezultat – nie wtedy, gdy liczby wyglądają tylko schludnie.
Więcej samouczków w tej sekcji
Gotowy, aby zastosować to w praktyce?
Bezpłatne sprawdzenie · 7-dniowy okres próbny · bez karty kredytowej