Przejdź do głównej zawartości

Inspiracje dla Technical Writera - dokumentacja online

· 2 min aby przeczytać

Dziś mamy dla Was kilka konkretnych przykładów dokumentacji online, w ramach poszerzania horyzontów 😊

Globalizacja, rozwój technologiczny, a ostatnio pandemia sprawiły, że ludzka aktywność przeniosła się w dużej mierze do Internetu. To tu pracujemy, szukamy rozrywki, inspiracji, kontaktu z innymi użytkownikami, a także szeroko rozwiniętej pomocy w rozwiązywaniu problemów. Dlatego też technical writerzy coraz częściej tworzą dokumentację w formie cyfrowej - mogą to być strony internetowe, filmy, bazy wiedzy czy wręcz całe portale. Poniżej znajdziecie przykłady właśnie takiej dokumentacji. Być może przyda się szukającym inspiracji i chcącym być na bieżąco z aktualnymi trendami w organizacji i prezentacji dokumentacji technicznej.

Online Help
Documentation Portal
Support

Dużo więcej przykładów znajdziecie na stronie Customer Showcase w serwisie internetowym MadCap Software. Przy sporej części z nich znajduje się link do case study, z którego dowiecie się jak powstała dana strona internetowa i dlaczego została ona stworzona w taki, a nie inny sposób. To spory zastrzyk wiedzy dla kogoś, kto tworzy dokumentację. Można dzięki temu zobaczyć od czego zależy design dokumentacji, dlaczego powinna ona spełniać takie, a nie inne założenia, jak w tym wszystkim ma poruszać się klient oraz, oczywiście, jak w tym wszystkim mogą pomóc produkty MadCapa.

Zestawienie przykładów, a także ich analiza, pokazuje również jakie są obecne trendy w tworzeniu dokumentacji dostępnej online, co dodatkowo może pomóc technical writerom w pracy.

A Wy gdzie szukacie inspiracji i nowinek ze świata dokumentacji. Czy takie przykłady jak powyżej są dla Was pomocne? Jak zawsze, zachęcamy do dyskusji 😉