Jak napisać podręcznik użytkownika oprogramowania: kompletny przewodnik (wraz z szablonem)

Nie wiesz, jak napisać instrukcję obsługi oprogramowania dla swojego produktu?

Jeśli chcesz pomóc swoim użytkownikom uzyskać jak najwięcej korzyści z produktu w najbardziej efektywny sposób, stworzenie wysokiej jakości podręcznika użytkownika oprogramowania jest doskonałym miejscem do rozpoczęcia.

Udostępniając użytkownikom treści, których potrzebują, aby mogli się uczyć i samodzielnie rozwiązywać problemy z Twoim produktem, możesz pomóc im odnieść sukces bez konieczności kontaktowania się z Twoimi kanałami pomocy technicznej.

To nie tylko ułatwia pracę użytkownikom, ale może również zmniejszyć liczbę próśb o wsparcie w Twojej firmie, co pozwala zaoszczędzić czas i pieniądze.

Jak zatem stworzyć idealną instrukcję obsługi oprogramowania dla swoich użytkowników? Taki jest cel tego przewodnika.

Aby pomóc Ci rozpocząć pracę, oto wszystko, co omówimy w tym poście:

• Czym jest instrukcja obsługi oprogramowania
• Jak napisać instrukcję obsługi oprogramowania w czterech krokach, w tym szablon instrukcji obsługi oprogramowania
• Najlepsze praktyki tworzenia wysokiej jakości treści do instrukcji obsługi

Zakopmy się!

Co to jest instrukcja obsługi oprogramowania?

Podręcznik użytkownika oprogramowania to dokumentacja zawierająca informacje na temat korzystania z aplikacji lub produktu oraz zarządzania nimi.

Podręcznik użytkownika oprogramowania może zawierać przewodniki wprowadzające, instrukcje, glosariusze, wskazówki dotyczące rozwiązywania problemów i inne podobne treści.

Zasadniczo zawiera wszystkie informacje, których użytkownicy potrzebują, aby czerpać korzyści z oprogramowania.

Zwykle zaczyna się od kroków instalacji, następnie obejmuje ogólny przegląd interfejsu i sposób korzystania z różnych funkcji, a następnie zagłębia się w rozwiązywanie problemów i często zadawane pytania, jeśli to konieczne. Ponownie udostępnimy poniżej bardziej szczegółowy szablon instrukcji obsługi oprogramowania.

Aby zobaczyć przykładową instrukcję obsługi oprogramowania, możesz zajrzeć do Instrukcji obsługi wózka widłowego 3, która przeskakuje bezpośrednio do objaśnienia interfejsu.

Jako inny przykład możesz spojrzeć na zawartość Slacka Pierwsze kroki, która również przechodzi bezpośrednio do wyjaśnienia interfejsu Slacka.

Dlaczego tworzenie instrukcji obsługi oprogramowania jest ważne?

Istnieją dwa główne powody, dla których warto stworzyć podręcznik użytkownika oprogramowania dla swojego produktu:

1. Ulepszone doświadczenie użytkownika – ułatwiając użytkownikom naukę korzystania z Twojego oprogramowania i maksymalizując wartość, jaką otrzymują z Twojego oprogramowania, Twoi użytkownicy będą mieli lepsze doświadczenia.
2. Mniejsze obciążenie pomocy technicznej — dając użytkownikom możliwość samodzielnego rozwiązywania problemów, możesz zmniejszyć obciążenie kanałów pomocy technicznej. Jest to szczególnie ważne, jeśli łączysz podręcznik użytkownika z innymi rodzajami treści pomocniczych, takimi jak baza wiedzy i/lub często zadawane pytania (FAQ).

Jak napisać instrukcję obsługi oprogramowania w czterech krokach

Przejdźmy teraz do ogólnego przewodnika krok po kroku, jak napisać instrukcję obsługi oprogramowania. W następnej sekcji omówimy również kilka najlepszych praktyk dotyczących rzeczywistej zawartości instrukcji obsługi.

Jeśli jesteś zainteresowany bardziej ogólnym spojrzeniem na te tematy, mamy również przewodnik, jak stworzyć dowolny rodzaj instrukcji obsługi.

1. Zaplanuj strukturę podręcznika użytkownika oprogramowania

Zanim zaczniesz tworzyć jakąkolwiek treść do swojego podręcznika, najpierw będziesz chciał odpowiednio zmapować strukturę swojego podręcznika.

Aby Twój podręcznik był jak najbardziej wyczerpujący, możesz chcieć zgromadzić wielu kluczowych interesariuszy, aby Ci w tym pomogli.

Może to na przykład obejmować sukces klienta, sprzedaż itd. – każdy, kto ma wiedzę, jak pomóc użytkownikom uzyskać jak największą wartość z produktu. W niektórych przypadkach może być również konieczne zatrudnienie większej liczby pracowników technicznych, którzy pomogą w bardziej zaawansowanych szczegółach.

Oczywiście, jeśli prowadzisz solowy projekt, sam będziesz nosił wszystkie te kapelusze. Na tym polega radość bycia założycielem solo.

Gdy masz odpowiednich posiadaczy wiedzy, możesz zbudować zarys instrukcji obsługi.

Aby uzyskać przybliżony szablon instrukcji obsługi oprogramowania, możesz wykonać coś takiego…

1. Spis treści – wymień różne sekcje w instrukcji obsługi, aby użytkownicy wiedzieli, czego się spodziewać.
2. Wprowadzenie – wyjaśnij cel instrukcji obsługi Twojego oprogramowania.
3. Wymagania systemowe — wyszczególnij wszelkie specyficzne wymagania, których użytkownicy potrzebują do korzystania z Twojego oprogramowania, takie jak specyfikacje sprzętu, system operacyjny itp.
4. Instrukcje instalacji — opisują, w jaki sposób użytkownik może zainstalować oprogramowanie.
5. Przegląd interfejsu użytkownika – przedstawia ogólny przegląd interfejsu.
6. Jak korzystać z określonych funkcji – utwórz sekcję dla każdej podstawowej funkcji, która pokaże użytkownikom, jak to działa.
7. Często zadawane pytania — opisz niektóre typowe pytania, które może mieć użytkownik.
8. Rozwiązywanie problemów — udostępniaj porady dotyczące rozwiązywania problemów.
9. Glosariusz – jeśli twoje oprogramowanie ma określoną terminologię, możesz dodać glosariusz na końcu instrukcji obsługi oprogramowania.
10. Dane kontaktowe pomocy technicznej — wyjaśnij, w jaki sposób użytkownicy mogą skontaktować się z pomocą techniczną, jeśli potrzebują dodatkowej pomocy. Chcesz zachować to na końcu, aby użytkownicy spróbowali sobie pomóc przed skontaktowaniem się z pomocą techniczną.

Nie musisz dokładnie przestrzegać tego szablonu podręcznika użytkownika oprogramowania — to tylko punkt wyjścia, aby dać ci wyobrażenie o tym, co możesz chcieć uwzględnić.

2. Utwórz zawartość podręcznika użytkownika oprogramowania

Gdy masz już zarys, możesz przystąpić do tworzenia treści podręcznika użytkownika oprogramowania.

Większość Twoich treści będzie stanowić tekst, ale nie zapomnij również o odpowiednich obrazach, plikach GIF i filmach.

Chociaż ten krok zajmie prawdopodobnie najwięcej czasu, na razie ograniczymy tę sekcję, ponieważ w następnej podzielimy się najlepszymi praktykami dotyczącymi podręczników użytkownika oprogramowania, które pomogą Twojemu zespołowi w tworzeniu skutecznych treści podręczników użytkownika.

To, kto pisze Twoje treści, będzie zależeć od wielkości Twojej organizacji i złożoności Twojego produktu. Jeśli nie masz dedykowanego autora tekstów technicznych, może być konieczne przypisanie treści do zespołu ds. sukcesu klienta lub zespołu technicznego, w zależności od złożoności oprogramowania.

Lub, jeśli jesteś założycielem solo, prawdopodobnie będziesz najlepszą osobą do napisania treści podręcznika, ponieważ masz najgłębsze zrozumienie swoich treści. Zawsze możesz zatrudnić redaktora, który pomoże Ci ulepszyć Twój pierwszy szkic.

3. Opublikuj podręcznik użytkownika oprogramowania

Po przygotowaniu treści podręcznika użytkownika oprogramowania należy opublikować podręcznik w taki sposób, aby użytkownicy mogli z niego łatwo korzystać.

Większość oprogramowania baz wiedzy lub oprogramowania dokumentacyjnego powinno dobrze działać w przypadku podręcznika użytkownika oprogramowania, chociaż zawsze możesz napisać własne rozwiązanie, jeśli czujesz się zbyt ograniczony. Niektóre firmy oprócz wersji internetowej publikują również wersję PDF instrukcji obsługi.

Aby zapoznać się z doskonałymi opcjami publikowania internetowej wersji podręcznika użytkownika oprogramowania, możesz sprawdzić nasze listy najlepszego oprogramowania bazy wiedzy i najlepszych narzędzi do tworzenia dokumentacji.

Jeśli szukasz oprogramowania z instrukcją obsługi, które zapewnia solidną listę funkcji, pełną kontrolę nad treścią i elastyczność w dostosowywaniu rzeczy do Twoich potrzeb, możesz skorzystać z naszej wtyczki WordPress Heroic Knowledge Base.

Heroic Knowledge Base to oprogramowanie typu open source, które rozszerza podobnie otwarty system zarządzania treścią (CMS) WordPress o wszystkie funkcje potrzebne do opublikowania instrukcji obsługi oprogramowania.

Będziesz mieć pełną kontrolę nad swoją platformą, a także elastyczność w dostosowywaniu każdego elementu do potrzeb. Ale jednocześnie Heroic Knowledge Base nadal zawiera wbudowaną funkcjonalność dla wszystkich ważnych funkcji, których potrzebuje Twoja instrukcja obsługi oprogramowania:

• Organizacja artykułów – możesz uporządkować artykuły w podręczniku oprogramowania za pomocą kategorii. Na przykład możesz mieć różne kategorie dla „Instalacji”, „Interfejsu”, „Korzystania z funkcji”, „Rozwiązywania problemów” i tak dalej.
• Funkcje odkrywania treści – aby pomóc użytkownikom znaleźć odpowiednią treść tak szybko, jak to możliwe, Heroic Knowledge Base zawiera przydatne funkcje odkrywania treści, takie jak sugestie wyszukiwania w czasie rzeczywistym, automatyczny spis treści i wiele innych.
• System opinii użytkowników – użytkownicy mogą dzielić się opiniami na temat przydatności każdego artykułu, dzięki czemu wiesz, co robisz dobrze (a gdzie musisz poprawić).
• Szczegółowe analizy – możesz śledzić, które artykuły uzyskują najwięcej wyświetleń, które artykuły prowadzą do największej liczby próśb o wsparcie przez ludzi, jakich terminów szukają użytkownicy, które wyszukiwania nie zwracają żadnych wyników i nie tylko.

4. Zaktualizuj podręcznik użytkownika oprogramowania na podstawie opinii i zmian

Tworzenie wysokiej jakości instrukcji obsługi oprogramowania nie jest rzeczą „jednorazową”. Po opublikowaniu podręcznika ważne jest, aby nadal wyznaczyć kluczowych interesariuszy do aktualizacji i poprawiania podręcznika w razie potrzeby.

W niektórych przypadkach te aktualizacje mogą być wymagane przez zmiany w oprogramowaniu. Na przykład, jeśli dodasz nową funkcję lub zmienisz interfejs oprogramowania, będziesz musiał zaktualizować instrukcję obsługi, aby uwzględnić te zmiany.

W innych przypadkach te aktualizacje mogą wynikać z opinii użytkowników. Na przykład, jeśli zauważysz, że użytkownicy są zdezorientowani przez określony artykuł, możesz zaktualizować ten artykuł, aby był bardziej przydatny.

Lub jeśli zauważysz, że użytkownicy szukają tematu, który nie istnieje w podręczniku użytkownika oprogramowania, może być konieczne utworzenie nowego artykułu na ten temat.

Opublikowanie instrukcji obsługi za pomocą narzędzia takiego jak Heroic Knowledge Base pozwoli Ci łatwo śledzić tego typu analizy, dzięki czemu będziesz mógł monitorować i ulepszać zawartość instrukcji obsługi.

Najlepsze praktyki pisania instrukcji obsługi oprogramowania

Teraz, gdy rozumiesz podstawowy proces pisania podręcznika użytkownika oprogramowania, przyjrzyjmy się kilku najlepszym praktykom tworzenia skutecznej treści podręcznika użytkownika.

Zrozum, kim są Twoi odbiorcy

Jeśli chcesz stworzyć pomocną treść podręcznika użytkownika, musisz wiedzieć, dla kogo piszesz:

• Skąd pochodzą Twoi użytkownicy.
• Co próbują osiągnąć za pomocą Twojego oprogramowania.
• Jakich bolączek doświadczają.
• Ich ogólny poziom wiedzy na temat Twojej branży i/lub odpowiednich obszarów technicznych.
• W jakiej firmie pracują (lub czy są użytkownikami indywidualnymi).
• Itp.

Załóżmy na przykład, że Twoje oprogramowanie współpracuje z Salesforce. Jeśli Twoimi docelowymi użytkownikami są doświadczeni administratorzy Salesforce, Twoje treści będą wyglądać zupełnie inaczej, niż gdyby Twoimi docelowymi użytkownikami byli sami handlowcy.

Prawdopodobnie już dobrze rozumiesz docelowych użytkowników ze swojej dotychczasowej pracy. Jeśli jednak nie masz pewności, możesz skorzystać z person, ankiet i wywiadów klientów, aby uzyskać głębsze zrozumienie.

Użyj struktury logicznej i organizacji

Wspomnieliśmy o tym w pierwszym kroku poprzedniej sekcji, ale ważne jest, aby zorganizować podręcznik użytkownika w optymalny sposób, aby ułatwić użytkownikom czerpanie korzyści z treści.

Podręcznik użytkownika można uporządkować na różne sposoby, aw różnych sekcjach można zastosować wiele podejść:

• Doświadczenie liniowe – możesz uporządkować swój podręcznik w taki sposób, w jaki użytkownicy będą doświadczać rzeczy. Na przykład możesz zacząć od „Instalacji” jako pierwszej sekcji, a następnie przejść do pierwszej akcji po instalacji w następnej sekcji.
• Funkcja — możesz uporządkować zawartość podręcznika w oparciu o różne funkcje oprogramowania.
• Rozwiązywanie problemów – możesz zebrać typowe kroki rozwiązywania problemów w jednym miejscu.

Ponownie, całkowicie w porządku jest stosowanie wielu podejść w podręczniku. Na przykład możesz zacząć od uporządkowania rzeczy w sposób liniowy dla procesu instalacji.

Ale kiedy już omówisz instalację i użytkownicy będą mogli zacząć stosować oprogramowanie na różne sposoby, możesz przejść na podejście do organizacji oparte na funkcjach.

Zadbaj o to, by Twoje pisanie było proste i spójne

Aby podręcznik użytkownika oprogramowania był jak najbardziej dostępny, ważne jest, aby jego pisanie było jak najprostsze.

Oto kilka rzeczy, o których należy pamiętać, aby tak się stało:

• Nie używaj żargonu ani mylących słów – nie wszyscy Twoi użytkownicy będą mieli taką samą wiedzę, jeśli chodzi o Twoją branżę i/lub język Twojego produktu, dlatego ważne jest, aby unikać niepotrzebnego żargonu technicznego i mylącego słownictwa. Możesz przetestować swoje treści za pomocą narzędzi, takich jak test Flesch Reading Ease, aby znaleźć problemy.
• Unikaj pasywnego głosu – używanie pasywnego głosu może być szczególnie mylące w instrukcji obsługi. Na przykład, zamiast używać strony biernej, takiej jak „Zapisanie kopii wersji roboczej można wykonać, naciskając przycisk Zapisz wersję roboczą ”, lepiej jest użyć głosu czynnego, takiego jak „Naciśnij przycisk Zapisz wersję roboczą , aby zapisać kopię projekt."
• Używaj krótkich zdań — dzielenie treści na krótkie zdania ułatwia użytkownikom konsumpcję i przeglądanie treści instrukcji obsługi. Jeśli to możliwe, unikaj długich akapitów („ściany tekstu”).
• Zachowaj spójność — stosowanie spójnych sformułowań i formatowania ułatwi użytkownikom zrozumienie instrukcji. Na przykład, jeśli zawsze używasz uporządkowanej listy do wyszczególnienia poszczególnych kroków w określonym zadaniu, spróbuj zachować to formatowanie w całej instrukcji obsługi.
• Unikaj problemów gramatycznych – upewnij się, że nie masz żadnych błędów gramatycznych, które mogłyby utrudnić użytkownikom zrozumienie instrukcji. Możesz to sprawdzić za pomocą narzędzi takich jak Grammarly i Hemingway.

Dołącz obrazy i filmy tam, gdzie jest to pomocne

Podczas gdy zawartość tekstowa będzie stanowić podstawę instrukcji obsługi, ważne jest, aby dołączyć również obrazy i filmy tam, gdzie ma to sens.

Powiedzenie, że „obraz jest wart tysiąca słów” może być banalne, ale z pewnością może być prawdziwe, gdy próbujesz wyjaśnić, w jaki sposób użytkownicy mogą czerpać korzyści z oprogramowania.

Aby pomóc w wyjaśnieniu pojęć zawartych w tekście, możesz dodać obrazy lub pliki GIF z adnotacjami, które pokazują, o czym mówisz.

Na przykład Slack wykonuje świetną robotę, dodając adnotacje do obrazów wprowadzających do interfejsu.

Treści wideo mogą być również przydatne dla niektórych użytkowników. Należy jednak uważać, aby polegać wyłącznie na treściach wideo, ponieważ nie zawsze jest to optymalny sposób korzystania przez użytkowników z treści podręcznika oprogramowania.

Na przykład, jeśli użytkownik po prostu próbuje rozwiązać problem z określonym szczegółem, zazwyczaj łatwiej jest mu znaleźć ten szczegół w treści tekstowej niż w filmie.

Utwórz podręcznik użytkownika oprogramowania już dziś

Na tym kończymy nasz przewodnik na temat tego, jak napisać świetny podręcznik użytkownika oprogramowania, który zapewni użytkownikom sukces.

Jeśli chcesz w najprostszy sposób opublikować instrukcję obsługi oprogramowania, możesz użyć wtyczki Heroic Knowledge Base do WordPress.

Heroic Knowledge Base to wtyczka typu open source, która pozwala wykorzystać system CMS WordPress do stworzenia własnego, samodzielnie hostowanego podręcznika użytkownika oprogramowania, nad którym masz pełną kontrolę.

Jednocześnie nie musisz rezygnować z funkcjonalności, ponieważ Heroic Knowledge Base oferuje wszystkie funkcje potrzebne do stworzenia świetnej instrukcji obsługi oprogramowania. Funkcje te obejmują sugestie wyszukiwania na żywo, organizację kategorii, zbieranie opinii użytkowników, analizy i wiele innych.

Jeśli jesteś gotowy, aby zacząć, kup Heroic Knowledge Base już dziś, a w mgnieniu oka otrzymasz świetnie wyglądającą instrukcję obsługi.