Ćwiczyć Trenować
Nauczyć się codziennej, standardowej obsługi produktu.
Użytkownicy muszą nauczyć się obsługi większości części produktu, które dotyczą ich pracy. Administratorzy muszą na przykład umieć tworzyć i usuwać użytkowników. Działanie „Ćwiczyć” opisuje potrzebę zdobycia wiedzy proceduralnej, czyli nauczenia się codziennej, standardowej obsługi produktu.
Przykłady dokumentacji wspierającej ćwiczenie to generowanie nowego klucza SSH w GitHubie, importowanie kontaktów do Mailchimpa oraz zarządzanie użytkownikami w Dynatrace. Wykorzystują różne wzorce poradników lub samouczków, z materiałami audiowizualnymi lub bez nich, ale łączy je cel: pomóc użytkownikom opanować procedurę.
Gdy użytkownicy potrafią pewnie wykonywać zadania, chętniej odkrywają zaawansowane funkcje i stają się rzecznikami produktu. Taka dokumentacja często stanowi trzon programów wdrażania użytkowników i ścieżek certyfikacyjnych, zamieniając wiedzę teoretyczną w praktyczne kompetencje.
Co użytkownik chce zrobić
Użytkownicy muszą nauczyć się obsługi większości części produktu. Ćwiczenie opisuje potrzebę wiedzy proceduralnej — tego, jak korzystać z produktu w codziennej, standardowej pracy.
Sygnały, że dokumentacja tego nie zapewnia
- Te same pytania typu „jak to zrobić” powracają we wsparciu i kanałach społeczności.
- Procedury istnieją wyłącznie jako wiedza plemienna albo w czyjejś głowie.
- Brakuje instrukcji krok po kroku dla typowych zadań administracyjnych.
Dwa przykłady z praktyki
Typowe rodzaje treści
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <task>, <step>, <choicetable> | Poradnik | Poradnik |
Jedna metryka
skuteczność zadania · Odsetek użytkowników, którzy wykonują standardową procedurę bez pomocy wsparcia.