9 wskazówek dotyczących niesamowitej dokumentacji użytkownika (z przykładami)

Dokumentacja użytkownika jest ważną częścią całego produktu dostarczanego klientowi. Pomaga użytkownikom końcowym odnieść większy sukces z Twoim produktem lub usługą.

W przeszłości dokumentacja użytkownika była przekazywana za pośrednictwem pliku pomocy, który był dostępny lokalnie na komputerze użytkownika lub fizycznej instrukcji lub broszury. Oznaczało to, że nie można było go łatwo aktualizować ani zmieniać, a dostawcy oprogramowania otrzymywali bardzo mało danych na temat wykorzystania ich treści.

W dzisiejszych czasach dokumentacja użytkownika jest prawie zawsze oferowana online, co pomogło pisarzom technicznym mieć większą wyobraźnię we wspieraniu użytkowników. Mogą zbierać dane, wypróbowywać różne techniki uczenia się, szybciej iterować i tworzyć bogatsze treści dla użytkowników.

Właśnie tam pojawia się ten wpis na blogu! i

W tym poście dowiemy się, co możesz zrobić, aby ulepszyć swoją dokumentację użytkownika i przejrzymy kilka przykładów doskonałej zawartości pomocy dla użytkowników.

Zacznij od planu

Jak większość rzeczy w życiu, najlepiej zacząć od planu, a tworzenie dokumentacji użytkownika nie różni się od tego. Dlatego przed rozpoczęciem upewnij się, że zadajesz sobie (i prawdopodobnie osobom proszącym o dokumentację) wiele pytań.

1. Rozważ swoją publiczność

Dla kogo to robisz? Użytkownik końcowy? Administrator systemu? Czy ta treść będzie sprawdzana tylko wewnętrznie, czy też będzie widoczna na zewnątrz? Dla kogo tworzysz dokumentację użytkownika pomaga ułożyć informacje, które udostępniasz.

2. Oceń i pamiętaj o celu końcowym

Głównym celem każdej dokumentacji jest nauczenie czegoś odbiorców. Po ustaleniu, kto zużyje twoją dokumentację, będziesz chciał zdecydować, co chcesz, aby z niej wydobyli.

Jakie działanie chcesz, aby Twoi odbiorcy mogli wykonać po zapoznaniu się z dokumentacją? Mając na uwadze odpowiedź na to pytanie, będziesz w stanie dostarczyć odpowiednią ilość treści do danego zadania.

3. Upewnij się, że dokumentacja użytkownika jest łatwa do znalezienia

Ukryta dokumentacja użytkownika jest prawie tak bezużyteczna jak zła dokumentacja użytkownika. Ważne jest, aby upewnić się, że tworzona przez Ciebie dokumentacja użytkownika jest łatwo dostępna dla tych, którzy jej potrzebują.

Oznacza to nie tylko upewnienie się, że jest widoczny, ale także oznacza, że ​​użytkownicy mogą nawigować w dokumentacji technicznej i szybko znajdować odpowiedzi na swoje pytania.

Im szybciej Twoi odbiorcy znajdą te odpowiedzi, tym będą szczęśliwsi. Zaoszczędzi to również czasu na odpowiadanie na ważne, ale często zadawane pytania dotyczące Twojego produktu.

Zwięzłe, mocne pisanie

Mocne pisanie to podstawa doskonałej dokumentacji użytkownika. Ale pisanie wpływa nie tylko na to, jak czyta lub brzmi dokumentacja użytkownika. Może mieć również wpływ na łatwość nawigacji w dokumentacji użytkownika.

4. Napisz opisowe tytuły i podtytuły

Upewnij się, że Twoje tytuły są przydatne i, co najważniejsze, konkretne. Pisanie tytułów lub podtytułów sformułowanych w celu odpowiedzi na pytanie jest często najlepsze. Umieszczanie tytułów w ramkach w ten sposób ułatwia użytkownikom końcowym znalezienie tego, czego szukają, a także pomaga pisać artykuły, które bezpośrednio odpowiadają na potrzeby użytkowników.

Unbounce wykonuje fantastyczną robotę, pisząc skuteczne tytuły i napisy w dokumentacji użytkownika. To sprawia, że ​​ich dokumentacja jest łatwa w nawigacji. Każdy konkretny artykuł ma swój własny spis treści, co sprawia, że ​​znalezienie odpowiedzi na konkretne pytanie jest dziecinnie proste.

5. Ułatw przeglądanie

Dostarczanie informacji w sposób łatwy do skanowania pomaga użytkownikom zaoszczędzić czas. Jako ludzie doceniamy wszelkie możliwe oszczędności czasu. Ponadto użytkownicy mogą nie wiedzieć dokładnie, czego szukają. Wtedy najbardziej korzystne są łatwe do przeglądania treści.

IBM wykonuje dobrą robotę, ułatwiając przeglądanie treści pomocy, organizując przejrzysty spis treści i udostępniając powiązane tematy.

6. Spraw, aby było łatwo przeszukiwać

Google nauczył nas, że znalezienie odpowiedzi na nasze pytania jest tak proste, jak wpisanie ich w polu wyszukiwania. Twoja dokumentacja pomocy powinna odzwierciedlać to oczekiwanie. Jeśli treści pomocy nie można przeszukiwać, prawdopodobnie nie jest ona zbyt pomocna.

Dogłębna baza wiedzy Hubspot ułatwia klientom samoobsługę.

Użyj wizualizacji, aby poprawić zrozumienie

Dobra dokumentacja użytkownika jest bardzo wizualna. Chociaż mocne pisanie i tekst są niezbędne do tworzenia wspaniałej dokumentacji użytkownika, ludzie najlepiej uczą się, gdy obecne są również elementy wizualne.

7. Użyj zrzutów ekranu z adnotacjami

Zrzuty ekranu z adnotacjami to potężne elementy wizualne do wykorzystania w dokumentacji użytkownika. Usuwają zgadywanie dla użytkowników, pokazując dokładnie, jakie kroki muszą podjąć.

Dzięki programom takim jak TechSmith Snagit łatwo jest dodawać objaśnienia tekstowe, strzałki i inne elementy do zrzutów ekranu. Na przykład zauważysz, że używam zrzutów ekranu z adnotacjami, które zrobiłem za pomocą Snagita w tym poście na blogu.

Jeśli czujesz się zainspirowany, możesz nawet wypróbować narzędzie Snagit's Step Tool, które pozwala identyfikować części obrazu poprzez umieszczanie uporządkowanych objaśnień podczas wskazywania i klikania. Za każdym razem, gdy klikniesz, aby dodać kolejny krok, liczba automatycznie się zwiększa.

Firmą, która świetnie sobie radzi z wykorzystaniem mocy zrzutów ekranu w swojej dokumentacji, jest Asana. W swojej niesamowitej dokumentacji użytkownika używają zrzutów ekranu z adnotacjami, aby wyraźnie poprowadzić klientów.

8. Wykorzystaj wideo, aby pokazać, a nie mówić

Wideo dobrze pokazuje proces. Wiele niesamowitej dokumentacji użytkownika łączy moc wideo z instrukcjami tekstowymi. Na przykład dobrą praktyką jest użycie krótkiego filmu w celu szybkiego omówienia procesu.

Następnie wraz z filmem możesz udostępnić tekstowy przewodnik krok po kroku, do którego użytkownicy będą mogli się odwołać podczas samodzielnego wypróbowywania procesu. W ten sposób nie muszą oglądać wideo w kółko, jeśli potrzebują tylko szybkiego przypomnienia.

W naszych samouczkach dotyczących produktów TechSmith używamy głównego filmu wideo, aby przedstawić pełny przegląd omawianej funkcji lub tematu. Następnie pod filmem udostępniamy fragmenty, którym towarzyszą zrzuty ekranu lub animowane pliki GIF, aby powtórzyć główne punkty filmu.

9. Pokaż przykłady i wyniki końcowe

Użytkownicy muszą wiedzieć, jak wygląda pomyślne wykonanie każdego zadania. Dostarczenie użytkownikom zrzutu ekranu przykładowego wyniku końcowego to dobry sposób na zademonstrowanie odbiorcom idealnego wyniku.

Świetna dokumentacja użytkownika ułatwia użytkownikom końcowym znalezienie odpowiedzi na ich pytania, co tworzy szczęśliwych, zadowolonych użytkowników.

Kluczową częścią tworzenia niesamowitej dokumentacji użytkownika jest dostarczanie jasnych, łatwych do zeskanowania informacji. Wizualizacje, takie jak zrzuty ekranu, filmy lub animowane pliki GIF, to świetne sposoby na wydajniejszą i skuteczniejszą komunikację z użytkownikami.