Dokumentacja oprogramowania: 5 łatwych sposobów na ulepszenie

Kiedy większość ludzi myśli o dokumentacji użytkownika oprogramowania, prawdopodobnie nie wyobrażają sobie niczego ekscytującego, wciągającego lub zabawnego. Dzieje się tak, ponieważ zbyt wiele podręczników użytkownika oprogramowania, przewodników szybkiego startu, samouczków i tym podobnych jest zdominowanych przez duże bloki tekstu, w których niewiele myśli się o tym, co uzyska z nich użytkownik końcowy.

Jest lepszy sposób.

Najlepsza dokumentacja użytkownika nie mówi klientom, jak korzystać z oprogramowania w ogromnych, trudnych do strawienia porcjach. Pokazuje im, jak za pomocą wizualizacji i filmów w kawałkach wielkości kęsa, które wyraźnie określają w prosty sposób, jak dokładnie wykonać zadania, które pomogą im odnieść sukces.

A co najważniejsze, jest to DUŻO łatwiejsze niż myślisz. Pokażę Ci pięć prostych sposobów na ulepszenie dokumentacji oprogramowania za pomocą materiałów wizualnych i wideo, które zachwycą Twoich klientów, jednocześnie pomagając im odnieść większy sukces dzięki Twoim produktom.

Oto, czego się dowiesz:

• Dlaczego wizualizacje i wideo oferują lepszy sposób nauczania i uczenia się.
• Jak wykorzystać zrzuty ekranu do wzbogacenia treści pomocy.
• Dlaczego uproszczona grafika zwiększa przejrzystość dla Twoich klientów i wydłuża żywotność Twojej dokumentacji użytkownika.
• Jak przekształcenie zrzutów ekranu w samouczki wideo nadaje nowy wymiar Twoim treściom.
• Dlaczego pliki PDF mogą nie być najlepszą opcją dla dokumentacji oprogramowania.

Dlaczego wizualna dokumentacja oprogramowania jest lepsza?

Kiedy przeprowadziliśmy nasze badanie The Value of Visuals, spodziewaliśmy się odkryć, że ludzie uczą się lepiej, gdy prezentują treści wizualne niż sam tekst. Ale nie spodziewaliśmy się, w jakim stopniu zawartość wizualna zrobiła różnicę.

Prawie 70% ludzi nie tylko woli instrukcje wizualne niż tekstowe, ale także szybciej się uczyli, dokładniej wykonywali zadania i dłużej zachowywali informacje. Szczerze mówiąc, było to niesamowite.

Nasza najnowsza analiza dotycząca przeglądarek wideo wykazała, że ​​coraz więcej osób szuka pomocy lub treści instruktażowych za pośrednictwem wideo, a nie chrupiącego starego pliku PDF lub strony internetowej z dużą ilością tekstu.

Najważniejsze jest to, że ludzie nie tylko wolą wizualizacje i filmy (tak!), ale także czerpią z nich więcej.

Oznacza to, że będziesz mieć szczęśliwszych, odnoszących większe sukcesy klientów i zmniejszysz liczbę połączeń telefonicznych, e-maili i innych zapytań do personelu wsparcia technicznego.

Jak ulepszyć dokumentację oprogramowania za pomocą materiałów wizualnych i wideo

Tak więc wizualizacje i wideo są kluczowym elementem każdej dobrej strategii dokumentacji oprogramowania, ale myślenie o tworzeniu tego typu treści może być również onieśmielające, zwłaszcza jeśli masz niewielkie doświadczenie lub nie masz go wcale.

Nie musi tak być. Tworzenie wysokiej jakości materiałów wizualnych i wideo może być niezwykle łatwe — nawet jeśli nigdy wcześniej ich nie tworzyłeś.

Oto pięć prostych sposobów na ulepszenie dokumentacji oprogramowania za pomocą elementów wizualnych.

1. Użyj zrzutów ekranu

Zrzuty ekranu to jeden z najprostszych sposobów dodawania obrazów interfejsu użytkownika oprogramowania do dokumentacji.

Nawet zwykły zrzut ekranu może być ogromną pomocą dla użytkowników, którzy próbują poruszać się po oprogramowaniu lub witrynie, ale wzbogacone o adnotacje i objaśnienia stają się niezbędnym i łatwym do zrozumienia narzędziem.

Jeśli obraz jest wart 1000 słów, dobry zrzut ekranu musi być wart 10 000.

Chociaż dostępne są bezpłatne narzędzia do zrzutów ekranu, bardziej wydajna i wszechstronna opcja, taka jak TechSmith Snagit, sprawia, że ​​tworzenie wysokiej jakości obrazów jest jeszcze łatwiejsze. Możesz pokazać tyle lub za mało ekranu, ile potrzebujesz, a łatwe objaśnienia i adnotacje Snagita oznaczają, że możesz podświetlić ważne elementy lub zwrócić uwagę użytkowników na to, co najważniejsze.

Seria zrzutów ekranu może pokazać kroki, aby wykonać zadanie, lub narzędzie Snagit może pokazać to wszystko na jednym obrazie.

Dowiedz się, jak tworzyć skuteczne zrzuty ekranu

2. Użyj uproszczonej grafiki

Wiele interfejsów oprogramowania może być skomplikowanych, oferując wiele opcji. I w większości przypadków, gdy chcesz pokazać proces lub instrukcje, nie musisz pokazywać całości. W rzeczywistości czasami pokazanie całego interfejsu może być mylące.

Uproszczona grafika pomaga uwydatnić nieistotne części zrzutu ekranu i podkreślić to, co użytkownicy powinni zobaczyć.

Dzięki Snagit tworzenie uproszczonej grafiki nigdy nie było łatwiejsze. Wystarczy wybrać narzędzie Uprość, a po wybraniu opcji Auto-uproszczenie Snagit zajmie się resztą. Możesz wybrać, ile szczegółów chcesz, aby Snagit pokazywał i usunąć wszelkie uproszczenia, których nie potrzebujesz.

Aby uzyskać bardziej precyzyjną kontrolę, możesz również ręcznie zastosować uproszczenie.

Jakkolwiek to zrobisz, uproszczona grafika pomoże Twoim użytkownikom dokładnie zrozumieć, na czym powinni skupić swoją uwagę.

3. Zamień swoje zrzuty ekranu w wideo

Chociaż obrazy są potężnym i użytecznym sposobem na ulepszenie dokumentacji oprogramowania, filmy mogą jeszcze bardziej ją rozwinąć, dodając do miksu instrukcje dotyczące ruchu i głosu.

Teraz, jeśli nigdy wcześniej nie nagrywałeś filmu, myśl o rozpoczęciu może być niesamowicie zniechęcająca. Ale możesz tworzyć bardzo skuteczne filmy z niewielkim doświadczeniem wideo lub wcale. W rzeczywistości, jeśli potrafisz zrobić zrzut ekranu, jesteś na dobrej drodze!

Po raz kolejny na ratunek przychodzi Snagit. Snagit umożliwia wykonanie serii zrzutów ekranu i przekształcenie ich w szybki film, który możesz udostępnić w ramach dokumentacji oprogramowania, treści pomocy i nie tylko. W rzeczywistości jest to również świetny sposób dla zespołu pomocy technicznej, aby pokazać użytkownikom, jak rozwiązać problem.

Możesz pobrać swoje zrzuty ekranu, a następnie nagrać wideo lub uzyskać zrzuty ekranu za pomocą funkcji Wideo z obrazów Snagit. Jakkolwiek to zrobisz, możesz dodawać dźwięki i adnotacje w trakcie.

4. Nagraj wideo

Zrzuty ekranu są świetne i przydatne na więcej sposobów, niż mogę zliczyć. Ale czasami wystarczy wideo.

W przeciwieństwie do wideo z obrazów, nagrywanie ekranu nagrywa wideo z ekranu i wszelkich ruchów myszy, kliknięć itp., Które wykonujesz.

Wbudowany rejestrator ekranu Snagit pozwala uchwycić cały ekran lub jego część, a także lektor, który chcesz dołączyć. Aby uzyskać dodatkową osobowość, możesz również dodać swój aparat.

Czasami ten osobisty kontakt znacznie pomaga użytkownikom czuć się mniej zestresowanym podczas nauki oprogramowania.

Pamiętaj jednak, że najlepsze filmy są jak najkrótsze, aby pokazać, czego chcesz uczyć. Nie próbuj pokazywać, jak korzystać z każdej funkcji w jednym filmie.

5. Wyjdź poza pliki PDF

Przenośny format dokumentów (PDF) firmy Adobe zmienił sposób, w jaki udostępniamy informacje. Są idealne, gdy chcesz, aby ktoś mógł pobrać i wydrukować doskonale sformatowaną kopię Twojej dokumentacji.

Ale spójrzmy prawdzie w oczy, kiedy ostatnio pobierałeś i drukowałeś dokumentację oprogramowania?

Jedną z najlepszych rzeczy w sieci jest to, że możemy udostępniać informacje bez konieczności ich drukowania. Przechowuj dokumentację oprogramowania na stronach w swojej witrynie, zamiast zmuszać użytkowników do uzyskiwania dostępu do pliku PDF. Będziesz mieć znacznie więcej opcji (w tym możliwość dołączania filmów), a w większości strony internetowe są znacznie łatwiejsze do aktualizacji niż dokumenty PDF, dzięki czemu Twoi użytkownicy zawsze mają najbardziej aktualne informacje.

I, w przeciwieństwie do plików PDF, Twoje strony internetowe są łatwo przeszukiwane, co oznacza, że ​​gdy jeden z użytkowników chce uzyskać informacje o Twoim produkcie, jest bardziej prawdopodobne, że znajdzie Twoją treść.

Zawsze możesz oferować plik PDF jako dodatek do treści internetowych, ale nie twórz plików PDF w JEDYNY sposób, w jaki ludzie mogą uzyskać dokumentację oprogramowania.

I hej, nie zapominaj, że możesz również umieszczać swoje filmy w witrynach takich jak YouTube!

Lepsza dokumentacja oprogramowania = szczęśliwsi użytkownicy

Możesz nadal tworzyć dokumentację oprogramowania z dużą ilością tekstu i zmuszać klientów do przedzierania się przez nią, lub możesz dać im to, czego chcą ORAZ to, co faktycznie pomaga im szybciej i wydajniej korzystać z Twoich produktów.

Dodaj więcej materiałów wizualnych i wideo do swojej dokumentacji, a zapewnisz lepszą obsługę swoim klientom.

A dzięki Snagit dosłownie każdy może tworzyć niewiarygodnie profesjonalnie wyglądające wizualizacje i filmy, które zachwycą Twoich klientów, zredukują liczbę połączeń i e-maili do pomocy technicznej oraz pomogą tworzyć użytkowników na całe życie.