Kontekstowe linki z aplikacji (konwencja "?")
Blueprint GTM (OP-2.5) zakłada, że każdy główny widok aplikacji ma przycisk pomocy (“?”), który
otwiera dokładnie tę stronę dokumentacji, która go opisuje - nie stronę główną /docs, nie
wyszukiwarkę. To dokumentuje tę konwencję (adresy URL, nazewnictwo), żeby wdrożenie linku “?” po
stronie aplikacji (app-nis2) miało jeden, stabilny wzorzec do naśladowania.
Wzorzec adresu
Dział zatytułowany „Wzorzec adresu”https://szbihub.pl/docs/<sekcja>/<slug>/#<kotwica><sekcja>- jedna z sekcji sidebara:start-tutaj,playbooki-partnera,moduly,rozwiazywanie-problemow,prawo,changelog.<slug>- nazwa pliku strony (bez rozszerzenia), np.m1-core-szbi.#<kotwica>- opcjonalna kotwica do konkretnego nagłówka na stronie (Starlight generujeidz każdego nagłówka automatycznie).
Mapowanie ekran -> strona docs (przykłady, docelowe)
Dział zatytułowany „Mapowanie ekran -> strona docs (przykłady, docelowe)”Poniższa tabela to zamierzony wzorzec, nie potwierdzenie, że dany ekran już istnieje w
aplikacji - większość z nich jest jeszcze w budowie (harmonogram faz F0-F4 w app-nis2).
| Ekran aplikacji (docelowo) | Moduł | Strona docs |
|---|---|---|
| Generator dokumentacji SZBI | M1 | /docs/moduly/m1-core-szbi/ |
| 4 rejestry ustawowe (ryzyka, incydentów, aktywów, szkoleń) | M1 | /docs/moduly/m1-core-szbi/#rejestry |
| Kalendarz terminów ustawowych | M1 | /docs/moduly/m1-core-szbi/#terminy |
| Ustawienia white-label (subdomena, branding) | M2 | /docs/moduly/m2-white-label/ |
| Szkolenie kierownika + rejestr ukończeń (art. 8e) | M3 | /docs/moduly/m3-szkolenia-8e/ |
| Dowolny ekran zgłaszania błędu / niejasnego zachowania | - | /docs/rozwiazywanie-problemow/ |
Zasada dla autorów treści
Dział zatytułowany „Zasada dla autorów treści”Każda nowa strona docs, która opisuje konkretny ekran/funkcję aplikacji, powinna:
- Mieć stabilny
slugpliku (nie zmieniać go po opublikowaniu - to zrywa istniejące linki “?”). - Zaczynać się od stanu funkcji (dostępna dziś / planowana / w budowie), zanim opisze szczegóły - patrz zasada “Docelowo (F4)” używana na stronie głównej.
- Nie duplikować treści prawnej - claimy prawne z referencją żyją w kolekcji
legalClaimsi renderują się przezClaimRefna stronach marketingowych/narzędziach, nie tutaj jako proza.