{"actions":[{"alt":"Rozpoznać","definition":"Rozpoznać główne cechy produktu i, jeśli ma to zastosowanie, porównać go z innymi.","description":"Użytkownicy dokumentacji są również potencjalnymi klientami lub osobami rozważającymi wdrożenie produktu. Czytelnik musi umieć rozpoznać jego główne cechy i porównać go z innymi. Jest to proces odkrywania.","examples":[{"title":"What is Databricks?","url":"https://docs.databricks.com/en/introduction/index.html"},{"title":"Splunk Observability Cloud Service Description","url":"https://docs.splunk.com/observability/en/get-started/service-description.html"}],"frameworks":{"diataxis":["Brak bezpośredniego odpowiednika (najbliższy: wyjaśnienie)"],"dita":["\u003ctopic\u003e","\u003cconcept\u003e"],"good_docs":["Omówienie","Strona docelowa"]},"id":"appraise","metric":{"description":"Współczynnik przejścia od dokumentacji do wdrożenia produktu.","name":"konwersja"},"signals":["Wsparcie i sprzedaż wielokrotnie odpowiadają na to samo pytanie: „Co to jest?”","Potencjalni klienci dowiadują się, co robi produkt, z tekstów marketingowych, a nie z dokumentacji.","Nie ma strony przedstawiającej pozycjonowanie ani główne zalety produktu."],"verb":"Ocenić"},{"alt":"Odkrywać","definition":"Wypróbować produkt i odkryć jego możliwości przy niskiej barierze wejścia.","description":"Świetne produkty zachęcają użytkowników do interakcji i próbowania nowych rzeczy. Dokumentacja powinna oferować wskazówki, instrukcje i możliwości działania, które ułatwiają eksplorowanie jako jedną z pierwszych aktywności.","examples":[{"title":"React Quick Start","url":"https://react.dev/learn"},{"title":"Tour of Go","url":"https://go.dev/tour/welcome/1"}],"frameworks":{"diataxis":["Samouczek"],"dita":["\u003ctask\u003e","\u003cstep\u003e","\u003csubstep\u003e"],"good_docs":["Samouczek"]},"id":"explore","metric":{"description":"Czas od pierwszej wizyty do pierwszej udanej interakcji.","name":"czas do pierwszej wartości"},"signals":["Nowi użytkownicy nie mogą znaleźć krótkiego przewodnika ani środowiska testowego, aby wypróbować produkt.","Pierwsze doświadczenie to ściana materiałów referencyjnych, a nie prowadzona prezentacja.","Użytkownicy muszą przeczytać cały podręcznik, zanim będą mogli dotknąć produktu."],"verb":"Eksplorować"},{"alt":"Przywołać","definition":"Przywołać informacje, których nie dało się zapamiętać — od parametrów po kody błędów.","description":"Dokumentacja referencyjna zachowuje wartość po wielu latach. Użytkownicy przeglądają podręczniki, aby przypomnieć sobie, odszukać lub wydobyć informacje, których nie zdołali zapamiętać.","examples":[{"title":"Dockerfile reference","url":"https://docs.docker.com/reference/dockerfile/"},{"title":"GitLab CI/CD YAML syntax reference","url":"https://docs.gitlab.com/ee/ci/yaml/"}],"frameworks":{"diataxis":["Dokumentacja referencyjna"],"dita":["\u003creference\u003e","\u003crefsyn\u003e","\u003cproperties\u003e"],"good_docs":["Dokumentacja referencyjna","Słownik"]},"id":"remember","metric":{"description":"Odsetek wyszukiwań referencyjnych, które prowadzą do właściwej strony.","name":"trafność wyszukiwania w dokumentacji referencyjnej"},"signals":["Użytkownicy szukają parametru lub kodu błędu i niczego nie znajdują.","Materiały referencyjne są rozproszone po wpisach na blogach i zapisach rozmów.","Brakuje przeszukiwalnej, uporządkowanej dokumentacji składni lub ustawień produktu."],"verb":"Przypomnieć sobie"},{"alt":"Rozwiązać","definition":"Sprawnie diagnozować i rozwiązywać problemy, często pod presją.","description":"Problemy wynikające z błędnej konfiguracji, przypadków brzegowych lub rzeczywistych usterek są częścią doświadczenia użytkownika. Rozwiązywanie problemów odpowiada na potrzebę sprawnej diagnozy i naprawy, często gdy system nie działa lub zbliża się termin.","examples":[{"title":"Kubernetes Debug Pods","url":"https://kubernetes.io/docs/tasks/debug/debug-application/debug-pods/"},{"title":"Elasticsearch Troubleshooting","url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-common-cluster-issues.html"}],"frameworks":{"diataxis":["Poradnik zorientowany na problem"],"dita":["\u003ctroubleshooting\u003e","\u003ctrouble\u003e","\u003ccause\u003e","\u003cremedy\u003e"],"good_docs":["Przewodnik rozwiązywania problemów"]},"id":"troubleshoot","metric":{"description":"Mediana czasu od wystąpienia objawu do przywrócenia działania.","name":"czas do rozwiązania"},"signals":["W zgłoszeniach do wsparcia powtarza się to samo pytanie, a odpowiedź znajduje się w zapisie rozmowy zamiast w dokumentacji.","Komunikaty o błędach występują w kodzie, ale nigdy nie trafiają do dokumentacji.","Użytkownicy wyszukują tekst błędu i trafiają na stronę, która go nie zawiera."],"verb":"Rozwiązywać problemy"},{"alt":"Integrować","definition":"Budować na produkcie, rozszerzać lub integrować go, aby tworzyć dodatkową wartość.","description":"Użytkownicy często muszą budować na istniejących produktach, rozszerzać je lub integrować — poprzez integracje, rozszerzenia, wtyczki albo zupełnie nowe aplikacje. Nacisk jest prawie zawsze praktyczny.","examples":[{"title":"Vercel Approval Checklist","url":"https://vercel.com/docs/integrations/create-integration/approval-checklist"},{"title":"Chrome Debug extensions","url":"https://developer.chrome.com/docs/extensions/get-started/tutorial/debug"}],"frameworks":{"diataxis":["Poradnik"],"dita":["\u003ctask\u003e","\u003ccodeblock\u003e","\u003ccoderef\u003e"],"good_docs":["Poradnik","Dokumentacja API"]},"id":"develop","metric":{"description":"Liczba integracji lub rozszerzeń utworzonych przez użytkowników.","name":"wzrost ekosystemu"},"signals":["Pytania dotyczące integracji i rozszerzeń pozostają bez odpowiedzi albo są odsyłane na forum.","Brakuje przewodnika po budowaniu rozwiązań na bazie produktu.","Punkty rozszerzeń produktu nie są udokumentowane."],"verb":"Rozwijać"},{"alt":"Trenować","definition":"Nauczyć się codziennej, standardowej obsługi produktu.","description":"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.","examples":[{"title":"Generating a new SSH key (GitHub)","url":"https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent"},{"title":"Import contacts to MailChimp","url":"https://mailchimp.com/help/import-contacts-mailchimp/"}],"frameworks":{"diataxis":["Poradnik"],"dita":["\u003ctask\u003e","\u003cstep\u003e","\u003cchoicetable\u003e"],"good_docs":["Poradnik"]},"id":"practice","metric":{"description":"Odsetek użytkowników, którzy wykonują standardową procedurę bez pomocy wsparcia.","name":"skuteczność zadania"},"signals":["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."],"verb":"Ćwiczyć"},{"alt":"Nauczyć się","definition":"Pojąć abstrakcje i modele mentalne, na których opiera się produkt.","description":"Produkty programistyczne opierają się na abstrakcjach trudnych do pojęcia, lecz kluczowych dla prawidłowego użycia. Dokumentacja pojęciowa utrwala wiedzę zdobywaną podczas eksplorowania i ćwiczenia.","examples":[{"title":"Kubernetes Concepts","url":"https://kubernetes.io/docs/concepts/overview/components/"},{"title":"Thinking in React","url":"https://react.dev/learn/thinking-in-react"}],"frameworks":{"diataxis":["Wyjaśnienie"],"dita":["\u003cconcept\u003e","\u003cglossentry\u003e","\u003csection\u003e"],"good_docs":["Przewodnik pojęciowy","Słownik"]},"id":"understand","metric":{"description":"Odsetek głównych abstrakcji opisanych na osobnej stronie pojęciowej.","name":"pokrycie pojęć"},"signals":["Użytkownicy potrafią obsługiwać produkt, ale nie umieją wyjaśnić, dlaczego działa właśnie w ten sposób.","Pojęcia są wyjaśnione jedynie w komentarzach do kodu lub wewnętrznych wiki.","Brakuje słownika lub przewodnika pojęciowego opisującego główne abstrakcje produktu."],"verb":"Zrozumieć"}],"model":{"canonical":"https://passo.uno/seven-action-model/","description":"Opisowy model potrzeb użytkowników dokumentacji technicznej. Siedem działań obejmuje cele, które odbiorca dokumentacji może chcieć osiągnąć: ocenić, zrozumieć, eksplorować, ćwiczyć, przypomnieć sobie, rozwijać i rozwiązywać problemy.","license":"CC BY 4.0","source":"https://passo.uno/seven-action-model/index.md","title":"Model dokumentacji oparty na siedmiu działaniach","version":"2025-01-09"}}