Itqualityassurance
- Dlaczego ważne jest, aby stworzyć dokumentację, która jest przyjazna dla użytkownika?
- Jakie są różnice między dokumentacją użytkownika a dokumentacją systemu, jaka jest ich użyteczność?
- Co powinno być zawarte w dokumentacji użytkownika?
Dlaczego ważne jest, aby stworzyć dokumentację, która jest przyjazna dla użytkownika?
Przyjazny dla użytkownika język i treść w dokumencie przyczyniają się do zdolności użytkownika do zrozumienia przedstawionych informacji i zastosowania tych informacji zgodnie z przeznaczeniem.
Jakie są różnice między dokumentacją użytkownika a dokumentacją systemu, jaka jest ich użyteczność?
Dokumentacja systemu reprezentuje dokumenty opisujące sam system i jego części. Zawiera dokumenty wymagań, decyzje projektowe, opisy architektury, kod źródłowy programu i często zadawane pytania. Dokumentacja użytkownika obejmuje instrukcje przygotowywane głównie dla użytkowników końcowych administratorów produktu i systemu.
Co powinno być zawarte w dokumentacji użytkownika?
Świetna dokumentacja użytkownika powinna obejmować: zwykły język, prostotę, wizualizację, skupienie się na problemie, logiczną hierarchię i przepływ, spis treści, treść możliwej do wyszukiwania, dostępną treść, dobry projekt, opinie prawdziwych użytkowników i linki do dalszych zasobów.
