[Intum Pomoc](https://intum.pl/pomoc.md) / [Zastosowania](https://intum.pl/pomoc/baza-wiedzy/zastosowania.md)

# [Pomoc w Twojej aplikacji](https://intum.pl/pomoc/baza-wiedzy/pomoc-w-aplikacji.md)

Jeśli masz własny system albo aplikację dla klientów, najlepsza pomoc to taka, której nie
trzeba szukać. Użytkownik stoi przy polu, którego nie rozumie, klika „?" i widzi dwa zdania
wyjaśnienia z linkiem do pełnej instrukcji. Treść prowadzisz w bazie wiedzy, a aplikacja tylko
ją wyświetla. Poprawka tekstu nie wymaga więc wydania nowej wersji.

> [!PATH]
> [Baza wiedzy → Helplinki](app:/kb/helplinks)

## Plan

1. **Załóż bazę z dokumentacją produktu** i ułóż kategorie według modułów aplikacji. Tu,
   inaczej niż w centrum pomocy, układ według menu jest w porządku: użytkownik jest w aplikacji
   i szuka pomocy do ekranu, który ma przed sobą.
2. **Pisz wpisy z nagłówkami na każde pole albo krok.** Jeden wpis „Nowe zamówienie"
   z sekcjami obsłuży kilka helplinków naraz, bo helplink może wskazać pojedynczą sekcję.
3. **Wstaw linki prosto do ekranów** w formie `app:/ścieżka` i ustaw w bazie
   **Adres systemu dla linków do ekranów**. Czytelnik po kliknięciu trafia na ten ekran na
   swoim koncie ([Szablon i wygląd](baza-wiedzy/szablon-i-wyglad-bazy-wiedzy)).
4. **Dodaj helplinki** przy polach i przyciskach, które najczęściej budzą pytania
   ([Helplinki](baza-wiedzy/helplinki)). Klucz nadaj według miejsca w aplikacji,
   np. `zamowienia_nowe_termin`, żeby po roku było jasne, gdzie on jest.
5. **Podepnij panel pomocy pod własny przycisk „Pomoc"** w aplikacji zamiast zakładki przy
   krawędzi ekranu ([Własny przycisk](baza-wiedzy/zakladka-bazy-wiedzy#wlasny-przycisk)).

## Dla programistów i integracji

Gdy aplikacja ma API, opis endpointów trzymaj w polu **Dokumentacja API** tego samego wpisu, co
instrukcja dla ludzi. Obie wersje zmieniają się wtedy razem
([Pisanie wpisów z AI](baza-wiedzy/pisanie-wpisow-z-ai)).

## Po czym poznać, że działa

Lista helplinków pokazuje **Otwarcia** i **Kliknięcia** każdego z nich:

- dużo otwarć w jednym miejscu to sygnał, że samo pole jest niejasne. Czasem lepiej poprawić
  jego nazwę w aplikacji, niż dopisywać pomoc,
- dużo otwarć i mało kliknięć to znak, że krótki fragment wystarcza albo nie prowadzi dalej.
  Przeczytaj go jeszcze raz oczami użytkownika.

Zmiana w aplikacji to także zmiana w pomocy. Przy każdym wydaniu sprawdź wpisy o zmienionych
ekranach, a nowości opisz w [changelogu](baza-wiedzy/widget-changelog).