Przewodniki użytkownika są ważną częścią świadczenia usług cyfrowych. Klienci cyfrowi oczekują dostępu do samoobsługi, żądając natychmiastowego dostępu do informacji. Telefoniczna instrukcja obsługi już nie wystarcza; godziny spędzone na wyjaśnianiu rzeczy, które można lepiej zilustrować w przewodnikach dokumentacji użytkownika.
W Docsie zalecamy, aby wszystkie firmy stworzyły bibliotekę przewodników użytkownika dla klientów. Umożliwi to samoobsługę, zmniejszy obciążenie związane z pomocą techniczną i zapewni całodobowy dostęp w czasie rzeczywistym do informacji potrzebnych klientom do korzystania z produktu lub usługi.
10 najważniejszych wskazówek dotyczących przewodników użytkownika i dokumentacji w Docsie
Zanim zaczniemy, czy masz sposób na przechowywanie, pisanie i hostowanie dokumentacji?
Udaj się na stronę Docsie Onboarding, aby uzyskać współpracę zorientowaną na klienta, rozbudowane osadzanie, dostosowane tłumaczenia i wydajne publikowanie na wyciągnięcie ręki.
Teraz, gdy dołączyłeś do klubu, przejdźmy do naszych 10 najważniejszych wskazówek!
1 - Wzbogać swoje przewodniki użytkownika o multimedia
Tekst, słowa, litery - używamy ich każdego dnia. Niestety, słowo pisane nie może równać się z prawdziwością wideo lub inspiracją obrazów.
Tworząc przewodniki po dokumentacji użytkownika, czytaj je z perspektywy użytkownika. Czy tę sekcję można lepiej wyjaśnić za pomocą GIF-a, osadzonego wideo lub obrazu z adnotacjami? Jeśli tak, dodaj je!
Możesz dodawać obrazy, osadzać filmy i integrować zawartość iFrame w Docsie. Spróbuj!
Obrazy, wideo i GIF-y w Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_CdhFEVXwXaefNXxxg/boo_dqsfhc7ObadQ3xWmV/e0eda1c6-284a-3e0f-5c43-0ff4099966d0BlogGIF10TipsforUserGuides.gif)
2 - Stwórz zamówienie, nie takie jak Jedi!
Instrukcje krok po kroku są filarem książek kucharskich na całym świecie! Czy postępując zgodnie z przepisem, mieszasz jajka z mąką? Tak właśnie powinieneś zrobić, a wiesz o tym, ponieważ postępujesz zgodnie z instrukcjami!
Żarty na bok, upewnij się, że przejrzałeś wszystkie instrukcje użytkownika z instrukcjami krok po kroku. Jeśli wykonasz te kroki, czy rzeczywiście uzyskasz zamierzony rezultat? Niedokładne instrukcje, które nie osiągają zamierzonego rezultatu, są ogromną czerwoną flagą dla klientów. Z drugiej strony dokładne instrukcje wzbudzają zaufanie i zapewniają wartość klientom i firmie poprzez wymianę informacji.
Stwórz porządek za pomocą numerowanych list w Docsie lub za pomocą Docsie Book Articles, aby posegmentować swoją dokumentację.
Artykuły, półki i obszary robocze w Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_O4Ux6ERzhyIS0eB1X/boo_dqsfhc7ObadQ3xWmV/aa925138-ab48-e18b-ff33-50557a2897cfArticlesShelvesWorkspacesinDocsie.png)
3 - Dostosowanie do wszystkich poziomów czytania
Czy zakładasz, że klienci będą znali JavaScript z Twoich najważniejszych wskazówek? Używanie żargonu i złożonej terminologii jest zwykle zalecane w kontekście technicznych przewodników użytkownika. Jednak dla laików, im prostszy język - tym lepiej!
Większość czytelników chce po prostu wiedzieć, jak zrobić daną rzecz i powtórzyć ją. Jednym z podejść jest dostarczenie złożonej, wysokopoziomowej koncepcji na papierze - a następnie powtórzenie jej w uproszczonej wersji dla laików. W ten sposób zaspokaja się potrzeby użytkowników technicznych i laików jednocześnie, tuszując dwie strony jednym piórem.
"Sztuczna inteligencja obejmuje algorytmiczną emulację ludzkiej inteligencji w dążeniu do produktywności; sztuczna inteligencja ma na celu wykonanie pracy poprzez dopasowanie ludzkiej inteligencji za pomocą kodu komputerowego". - Oba oznaczają to samo, ale są skierowane do różnych odbiorców.
Użyj Docsie, aby utworzyć półki dla laików i półki dla użytkowników technicznych. W ten sposób możesz mieć książki, które pomogą obu grupom odbiorców, z pełnym hostingiem dostępnym za pośrednictwem portalu Docsie.
4 - Używaj szablonów i przestań siedzieć do późna!
Czy przepisujesz każdy podręcznik użytkownika od zera? Zamiast tego powinieneś tworzyć szablony z podstawową strukturą i przekazem marki, a następnie budować wokół tych treści.
Pisanie od podstaw wymaga czasu, wysiłku i wiąże się z ryzykiem niespójności, jeśli wielu autorów pracuje nad tym samym projektem. Szablony to świetny sposób na zaoszczędzenie czasu podczas pisania i zapewnienie większej spójności między stronami. Zaufanie buduje się na spójnym przekazie i generowaniu wartości, które promują szablony.
Kliknij ...Więcej i wybierz Szablony w Docsie. Tutaj możesz przechowywać szablony i rozpoczynać nowe książki, używając szablonu jako źródła!
5 - Pisz szybko, często iteruj
W zwinnym tworzeniu oprogramowania mantrą jest szybkie niepowodzenie i częste iteracje. Stosując to do przewodników po dokumentacji użytkownika, pracownicy powinni dążyć do szybkiego pisania i częstej iteracji.
Nie oznacza to poświęcenia jakości na rzecz szybkości. Zamiast tego pozwala to na uzyskanie opinii klientów i odpowiedzi przy mniejszym początkowym wysiłku. Opinie te można wykorzystać w kolejnych iteracjach przewodnika po dokumentacji użytkownika i pomagają firmie stać się bardziej zorientowaną na klienta.
Docsie Vocally wyjaśnia opinie czytelników, z ocenami i nagraniami ekranu, aby dokładnie określić treść, którą czytają. Wypróbuj to rozwiązanie, pisząc szybko i często iterując!
6 - Zagnieżdżona wiedza z wewnętrznymi linkami zwrotnymi
Czy dokumentacja podręcznika użytkownika jest powiązana z innymi stronami? Dodając linki do odpowiednich sekcji dokumentacji, pomagasz czytelnikom rozwinąć i zrozumieć Twój produkt lub usługę na poziomie koncepcyjnym.
Kiedy odnosisz się do konkretnej funkcji lub funkcji, zawsze dodawaj link. Pozwól czytelnikowi na szybki dostęp do tych informacji, zamiast zmuszać go do samodzielnego wyszukiwania i ładowania strony. Mówisz o logowaniu do konta? Dodaj adres URL logowania do tekstu "zaloguj się na swoje konto" na swojej stronie i na każdej innej stronie. Uczyń swoją dokumentację wygodną i łatwą w nawigacji w tekście, a nie niekończącą się biblioteką do przeszukiwania.
Docsie pozwala autorom przewodników użytkownika na tworzenie wewnętrznych linków zwrotnych. Wystarczy zaznaczyć tekst i kliknąć przycisk 🖇️ na pasku narzędzi edytora Docsie. Dodatkowo, możesz tworzyć linki niezależne od języka i wersji za pomocą Relative object links .
7 - Usuń pajęczyny i odśwież starą zawartość
Czy posiadasz stare podręczniki użytkownika i dokumentację widoczną online? Jeśli posiadasz dokumentację w wersji 1.2 opublikowaną podczas gdy twój produkt jest w wersji 1.3, twoja dokumentacja nie jest już istotna. Zamiast publikować nową dokumentację dla każdej wersji, skorzystaj z Docsie Versioning.
Docsie Versioning pozwala użytkownikom na dostęp do historycznych i aktualnych wersji dokumentacji. W miarę wydawania nowych wersji, stare wersje są archiwizowane dla celów redundancji, a jednocześnie są dostępne z rozwijanego menu. Wszystko to znajduje się na tej samej stronie internetowej, co ułatwia użytkownikom przeglądanie i znajdowanie odpowiednich informacji.
Podobnie, jeśli Twój przewodnik z najlepszymi wskazówkami na 2021 r. jest nadal publikowany w 2022 r., zaktualizuj go! Zmień nazwę, odśwież wszelkie cytaty i źródła za pomocą zaktualizowanych badań i dokładnie sprawdź, czy informacje są nadal aktualne. Usuń pajęczyny i zachowaj wiecznie zielone treści; zawsze można zmienić ich przeznaczenie.
8 - Miniaturyzuj zadania, wykonuj je partiami
Czy podczas pisania piszesz całą stronę za jednym zamachem, bez wcześniejszego planowania? Część z tego sprowadza się do osobistych preferencji pisarzy. Miniaturyzacja zadań pozwala jednak wykonywać pracę szybciej i w większym skupieniu.
Stwórz prostą strukturę z tagami H1 i H2 oraz krótkimi opisami dla każdej sekcji. Wykorzystaj to podczas pisania i zajmij się poszczególnymi sekcjami, zamiast martwić się o całą stronę. W branży pisarskiej określa się to mianem konspektu. Zarys zapewnia możliwość uzyskania opinii od redaktorów przed rozpoczęciem pisania i działa jako ramy przewodnie podczas pisania.
Utwórz nową książkę w Docsie i dodaj kilka podstawowych nagłówków i tekstu dla konspektu. Możesz także dodawać zadania za pomocą menu po prawej stronie, dzieląc pracę na mniejsze partie, gdy wielu członków zespołu współpracuje nad treścią. Historia wersji oznacza, że możesz cofnąć się, jeśli autor doda mniej niż dobrą treść - idealne rozwiązanie do szybkiego pisania i częstych iteracji!
Kalendarz zadań w Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_4JCx9FdXnyXu3quMX/boo_dqsfhc7ObadQ3xWmV/d3468298-7bc2-7f51-7afe-2437f6321658TaskMiniaturizeCalendarDocsie.png)
9 - Spis treści dla większej liczby czytelników
W przypadku złożonej i zróżnicowanej dokumentacji podręcznika użytkownika, ściana tekstu może być onieśmielająca dla czytelników. Problem ten można rozwiązać za pomocą obszernego spisu treści. Powszechnie stosowany w encyklopediach, pomaga użytkownikom identyfikować i przeskakiwać do istotnych informacji, zapewniając jednocześnie strukturę w środowisku portalu wiedzy.
Docsie Articles, Shelves i Workspaces pracują nad stworzeniem spisu treści. Zostanie on automatycznie wyświetlony po lewej stronie portalu wiedzy - zapewniając łatwy sposób poruszania się po bazie wiedzy. Dzięki tej wskazówce Docsie zrobi to za Ciebie!
10 - Opanuj swój temat
Czy twój pisarz jest ekspertem w danej dziedzinie? Podobnie, czy pisarz jest zaradny i dobry w badaniu tematów, których może nie znać? Ostatecznie, pomimo wszystkich naszych wskazówek, to autor dyktuje jakość przewodników po dokumentacji użytkownika.
Im lepiej rozumieją oni produkt, tym dokładniejsza będzie ich praca. Pozwól pisarzom na elastyczność w testowaniu i łamaniu produktu, ponieważ użytkownicy mogą napotkać podobne problemy. Jeszcze lepiej, przeprowadź swojego autora przez demo produktu z zespołem sprzedaży i daj mu praktyczne doświadczenie z potokiem sprzedaży i zawartymi w nim komunikatami. To ponownie zwiększa spójność, jednocześnie zmieniając pisarzy w użytkowników. Nie wszyscy pisarze stają się użytkownikami, ale wszyscy użytkownicy mogą stać się dobrymi pisarzami dzięki praktycznej wiedzy.
Wprowadź te wskazówki w życie w Docsie!
Dziękujemy za przeczytanie naszych 10 najlepszych wskazówek dla lepszych przewodników użytkownika. Zachęcamy do zastosowania tych wskazówek w swoich dokumentach Docsie!
Docsie to kompleksowa platforma do zarządzania dokumentacją, której firmy używają do tworzenia internetowych FAQ, dokumentów produktowych, przewodników użytkownika, dokumentów pomocy i podręczników użytkownika. Platforma oferuje współpracę zorientowaną na klienta, rozbudowane osadzanie, dostosowane tłumaczenia i wydajne publikowanie na wyciągnięcie ręki.
Wykonaj swój ruch przez onboarding z Docsie już dziś i dostarczaj swoim klientom zachwycającą dokumentację!