Dokumentacja produktu
Pomóż użytkownikom wykonywać zadania obsługiwane przez Twoją aplikację
Udostępnij użytkownikom praktyczne przewodniki, które wyjaśniają ścieżki w aplikacji i pomagają im wykonywać zadania.
Zamień funkcje produktu w praktyczne instrukcje
- Przygotuj zakres przewodnika
Przejrzyj sekcje dokumentacji i ich docelowych odbiorców.
- Odpowiedz na pytania dotyczące treści
Doprecyzuj, jakie procesy i informacje ma wyjaśniać przewodnik.
- Śledź usługę publiczną
Sprawdź postęp budowy i adres witryny z dokumentacją.
Wyjaśnij, jak korzystać z aplikacji
Dokumentacja uzupełnia prezentację produktu o praktyczne instrukcje. Zacznij od przewodnika na start, a następnie prowadź użytkowników przez procesy, które aplikacja faktycznie obsługuje.
Konfiguracja dokumentacji pokazuje definicje sekcji i pytania. Zapewnij kontekst, który pomoże wyjaśnić zadanie językiem użytkownika.
Utrzymuj przewodnik powiązany z działającą aplikacją
Wspieraj pierwsze przydatne działanie. Przewodnik na start daje nowym użytkownikom krótką drogę do produktu. Powinien wyjaśniać, od czego zacząć, jakie informacje są potrzebne i jaki wynik potwierdza ukończenie zadania.
Wyjaśnij powtarzalny proces. Szczegółowy przewodnik odwzorowuje rzeczywiste etykiety i działania aplikacji. Wymagania wstępne, numerowane kroki i oczekiwany wynik pomagają powtórzyć zadanie biznesowe bez interpretowania ogólnego opisu ekranu.
Odpowiedz na pytanie przekrojowe. Niektóre pytania dotyczą kont, kosztów lub publikacji, a nie jednego ekranu. FAQ daje zwięzłą odpowiedź i link do odpowiedniego przewodnika, dzięki czemu procedura jest w jednym miejscu, a nie powielana w całej witrynie.
Utrzymuj przewodniki powiązane z produktem
Po istotnej zmianie w aplikacji przejrzyj dokumentację. Przewodnik powinien używać etykiet i opisywać zachowanie, które użytkownicy faktycznie widzą.
Dokumentacja działa we własnej usłudze publicznej. Dodaj do niej link w witrynie i sprawdź przewodniki w językach, w których publikuje Twój projekt.
Pomóż użytkownikowi wykonać kolejne zadanie
Praktyczny przewodnik wyjaśnia, od czego zacząć, jakie informacje są potrzebne i jak sprawdzić wynik. Jego wartość polega na tym, że pomaga czytelnikowi działać w aplikacji.
Gdy zadanie obejmuje kilka obszarów, kontynuuj ścieżkę z pomocą powiązanych przewodników. Po zmianie ekranu przejrzyj dokumentację, aby instrukcje pozostały przydatne.
Od uzgodnionych funkcji do przydatnej pomocy
Przygotuj zakres przewodnika. Przejrzyj sekcje dokumentacji i zadania, które mają wyjaśniać. Jasno określ docelowego użytkownika i zachowanie aplikacji.
Uzupełnij brakujący kontekst. Odpowiedz na pytania dotyczące wymagań wstępnych, reguł i wyników. Tekst powinien odwoływać się do rzeczywistego interfejsu, a nie do wymyślonych elementów sterujących.
Sprawdzaj po publikacji i zmianach. Przejdź przewodnik w aplikacji, sprawdź jego języki i powiązane linki, a następnie wróć do niego, gdy zmieni się zadanie, którego dotyczy.
Ułatw korzystanie z produktu po pierwszej wizycie
Zapewnij instrukcje prowadzące do wyniku obok publicznej prezentacji tego, co robi aplikacja.
Pytania dotyczące dokumentacji produktu
Strona funkcji pomaga potencjalnemu klientowi zrozumieć możliwość i jej wartość. Przewodnik pomaga użytkownikowi wykonać zadanie, pokazując rzeczywiste elementy sterujące, wymagania wstępne i wynik. Wzajemnie się uzupełniają.
Narzędzia dokumentacji pokazują definicje sekcji i pytania. Przejrzyj zadania obsługiwane przez aplikację, uzupełnij brakujący kontekst i śledź postęp pisania.
Projekt publikuje zlokalizowane przewodniki dostępne dla jego zakresu. Sprawdź każdy opublikowany język, aby zachował pełną procedurę i właściwe etykiety interfejsu.
Po zmianie, która wpływa na zadanie, jego elementy sterujące lub oczekiwany wynik. Porównaj tekst z działającą aplikacją, zamiast zakładać, że pierwotne instrukcje nadal są aktualne.
Dokumentacja referencyjna endpointów dotyczy projektu z aktywnym, działającym API. Korzystaj z działających operacji i rzeczywistej dokumentacji; zaplanowane trasy nie wystarczą do opisania użytecznej integracji.