Nowoczesne standardy tworzenia dokumentacji użytkownika (User Help)

Cześć!

Jakie są obecnie najlepsze praktyki/standardy w tworzeniu dokumentcji/manuala/helpa dla użytkownika końcowego? Czy korzystacie lub macie do polecenia jakieś gotowe narzędzia w tym temacie?

Według mnie najważniejsze wymagania to:

Format: Statyczny HTML (łatwość hostowania).
Struktura: Każdy rozdział z unikalnym linkiem (Deep Linking).
Media: Wsparcie dla screenshotów i osadzania treści.

Przykład: Pomoc ZUS (tradycyjny układ: drzewo kategorii po lewej + treść po prawej) - pomijam przedpotopowy UI.

https://www.zus.pl/portal/pomoc/index.html?edycja_dokumentu.html

Polecam Notion, piszesz w markdown który jest o wiele bardziej przyjemny niż html, a następnie hostujesz klikając share na stronie głównej. Notion ma też możliwość importu i exportu pdf, więc łatwo będzie to w miarę potrzeby wydrukować.

Co do praktyk/standardów, im mniej treści na stronie, tym lepiej, ale też nie za mało, ogólnie musisz znaleźć dobry balans między tym kiedy zostawiać wszystko na jednej stronie, a kiedy dzielić je na podstrony. Kwestia wyboru.