Liczne firmy technologiczne SaaS zmagają się z procesem opracowywania i dystrybucji dokumentacji produktu (podręczników użytkownika, przewodników użytkownika i/lub samouczków) dla swoich klientów.
Często dzieje się tak z powodu braku wiedzy lub procesów dotyczących właściwej obsługi i tworzenia podręczników, a nawet tego, kto jest za nie odpowiedzialny.
Tak długo, jak na świecie będą istnieć narzędzia i oprogramowanie, będziemy potrzebować skutecznej komunikacji, aby skutecznie przekazywać innym informacje na temat użytkowania, rozwoju, funkcjonowania i architektury tych dóbr. Jeśli zastanawiasz się, dlaczego tak jest, odpowiedź jest prosta. Wynika to z faktu, że umiejętności komunikacji technicznej mają kluczowe znaczenie dla gromadzenia informacji i umożliwienia odbiorcom skuteczniejszego zrozumienia produktu lub technologii.
Podczas gdy komunikacja w świecie rzeczywistym odbywa się poprzez mowę, język ciała i wyrażanie emocji, w świecie wirtualnym komunikacja techniczna odbywa się poprzez dokumentację techniczną produktu!
Jedynym celem dokumentacji technicznej produktu jest ułatwienie użytkownikowi zrozumienia dynamiki działania i architektury produktu i technologii. Jest to raczej podręcznik "jak używać" dla nowych pracowników, użytkowników/klientów i każdego innego, kto musi być świadomy metod pracy, dokładny opis nakrętek i śrub produktu!
Obowiązkiem menedżerów produktu jest wzięcie na siebie odpowiedzialności za rozwój zespołu w celu tworzenia, zarządzania, publikowania i utrzymywania dopracowanej dokumentacji produktu.
Jestem pewien, że każdy menedżer produktu powiedział lub usłyszał w swoim dziale następujące słowa: "Dokumentacja produktu jest częścią obowiązków właściciela produktu"; "Każdy zespół programistów powinien dokumentować własne aplikacje"; "funkcja została wdrożona, czy instrukcja została zaktualizowana?" lub, co gorsza, "w dokumentacji technicznej jest błąd".
Najwyraźniej dokumentacja techniczna produktu może być nieco zagadkowa, tak prosta, jak się wydaje! Podczas gdy poszczególne osoby próbują rozwiązać lub kłócić się o linie w poprzednim akapicie, podręczniki i samouczki pogarszają się, co jest szkodliwe dla wizerunku "produktu / firmy".
Aby pomóc każdemu, kto doświadcza podobnych problemów, oto kilka procedur, które należy wdrożyć, aby zoptymalizować dokumentację produktu.
Jaki jest cel dokumentacji produktu?
Kiedy mówimy o dokumentacji produktu dla produktu technologicznego lub usługi, mówimy o informacjach, które go opisują i danych, które się do niego odnoszą.
Dokumentacja techniczna lub dokumentacja produktu ma na celu pomóc odbiorcom i klientom w wykorzystaniu, przeczytaniu, zrozumieniu i wykorzystaniu produktu. Większość dokumentacji produktów jest oczywiście tworzona w różnych obszarach, w tym w inżynierii, medycynie, informatyce i marketingu.
Doskonała dokumentacja techniczna produktu pomaga odbiorcom poruszać się po produkcie i umożliwia im korzystanie z niego bez komplikacji.
Inną kwestią jest to, że dokumentacja techniczna ma kluczowe znaczenie dla pomocy klientom i znacząco przyczynia się do budowania marki i zaufania do firmy. Użytkownicy szukają dokumentacji technicznej wtedy, gdy jej najbardziej potrzebują. Odbiorcy korzystają z produktu, aby poznać procesy i radzić sobie z problemami.
Oznacza to, że posiadanie dokładnej i kompleksowej dokumentacji produktu, która jest dynamiczna z możliwością wyszukiwania, jest bardzo ważne
Jakie są różne rodzaje dokumentacji produktu
Ta sekcja umożliwia sprawdzenie, jakiego rodzaju dokumentacji produktu potrzebujesz dla swoich klientów.
Istnieje wiele różnych typów dokumentacji produktu, które spełniają potrzeby różnych typów przypadków użycia i potrzeb użytkowników:
Dokumentacja użytkownika produktu: Składa się z podręczników użytkownika, poradników, samouczków, często zadawanych pytań, informacji o wydaniu i podręczników szkoleniowych, a także procedur operacyjnych.
Dokumentacja korporacyjna: Badania pokazują , że ponad 8 na 10 firm z 1000 badanych przedsiębiorstw korzysta z formalnych polityk i podręczników proceduralnych.
Istnieje wiele innych dokumentów korporacyjnych, które obejmują dokumentację odnoszącą się do polityk i procedur firm, jak stwierdzono w powyższych badaniach, podręczniki instruktażowe, praktyki techniczne, dokumentację behawioralną i etyczną. Jak również dokumentacja prawna, która może być chroniona hasłem. Również struktury firm, najlepsze praktyki i procedury, a także podręczniki konserwacji
Dokumentacja deweloperska: ten rodzaj dokumentacji zawiera instrukcje dotyczące rozwoju oprogramowania, specyfikacje funkcjonalne, specyfikacje techniczne, dokumentację i narzędzia wspomagające przepływ pracy dewelopera.
Teraz, gdy lepiej rozumiemy różne rodzaje dokumentacji technicznej i produktowej, omówmy, od czego zaczynają się pierwsze kroki solidnego zarządzania procesem tworzenia dokumentacji produktowej.
Zlokalizowanie kierownika ds. rozwoju dokumentacji produktu
Bardzo typową kwestią jest ustalenie, kto powinien być odpowiedzialny za dokumentację produktu, nie jako ktoś, kto tylko ją aktualizuje, ale jako ktoś, kto jest odpowiedzialny za jakość i sukces produktu.
Podczas gdy niektóre firmy uważają, że każdy właściciel produktu i / lub menedżer produktu jest odpowiedzialny za dokumentację produktu, a także inne działy, takie jak rozwój i dokumenty wsparcia, mogą być również powierzone odpowiedzialności za utrzymanie aktualnych i skutecznych podręczników użytkownika, przewodników użytkownika i wszystkich aspektów dokumentacji produktu.
Rozwój dokumentacji produktu ma wiele ruchomych części, ale tutaj wskażemy dwie z nich:
-
Kto rozumie sposób działania produktu na wszystkich poziomach (obejmuje to również zespoły ds. rozwoju produktu i specyfikacji).
-
Ci, którzy otrzymują informacje od klientów, którzy przeglądają dokumentację produktu i słuchają ich trudności, opinii i obaw dotyczących zrozumienia dokumentacji produktu.
Pierwsza część pomaga nam stworzyć przydzieloną dokumentację produktu z dostępną wiedzą, która jest wysyłana do klienta, który w zamian przekazuje informacje zwrotne i inicjuje drugi proces, który pomaga zoptymalizować dokumentację.
Czasami te dwa punkty nie są idealnie na swoim miejscu, co powoduje sytuacje, w których dokumentacja produktu nigdy nie otrzymuje niezbędnej uwagi.
Jednym z podejść jest wyznaczenie osoby odpowiedzialnej za "wydajność" dokumentacji produktu, podręczników produktu i instrukcji obsługi. Weźmy pod uwagę zamówienie zakupu, którego produktem jest "Dokumentacja produktu". Jest on odpowiedzialny za przejście przez wszystkie zespoły firmy, naszkicowanie sposobu, w jaki każdy produkt generuje swoje przewodniki i zidentyfikowanie wyzwań związanych z tym procesem.
Intencją nie jest, aby ten właściciel produktu i menedżer produktu byli całkowicie odpowiedzialni za generowanie i modyfikowanie podręczników, ale aby pomagali osobom w każdym zespole w zarządzaniu dokumentami.
Osoba ta powinna badać, w jaki sposób użytkownicy wchodzą w interakcję z dokumentami, oferować sposoby na bardziej płynne aktualizacje i zbierać informacje zwrotne w celu określenia, w jaki sposób ulepszyć dokumentację każdego produktu i objaśnienia dla zamierzonych odbiorców.
Posiadanie osoby odpowiedzialnej za wszystkie aspekty dokumentacji produktu, zarządzanie przepływem pracy i różnymi działami, które są wymagane do ukończenia tej dokumentacji, zwiększy produktywność w firmie, zwiększy świadomość i edukację klientów za pomocą portali wiedzy o produkcie, a przede wszystkim usprawni zrozumienie produktu.
Spójrz na dokumentację produktu jak na sam produkt.
Produkty istnieją po to, aby dostarczać wartość, która spełnia lub przekracza oczekiwania klienta. Na podstawie statystyk wygenerowanych przez D2WorldWide 73,7% osób ocenia dokumentację jako bardziej pomocną niż filmy, opakowania lub sprzedawcy, gdy szukają informacji o produktach, których zakup rozważają.
Rozważ czynniki, które przyczyniają się do atrakcyjności produktu. Istnieje kilka czynników, które mogą wpływać na atrakcyjność produktu, ale na potrzeby tego artykułu skoncentrujemy się na trzech. Przekraczają oczekiwania pod względem wartości; ich użytkowanie generuje satysfakcję; i są konkurencyjne.
Dodatkowo, te same koncepcje odnoszą się do dobrej dokumentacji produktu online. Dokumenty produktowe, które wykraczają "poza oczekiwaną wartość", ilustrują nie tylko sposób korzystania z określonego przedmiotu, ale także oferują rozwiązania, których klient nie jest świadomy lub nie uważa za możliwe. Zawsze trzeba zobaczyć, jak inne firmy inicjują swoją dokumentację produktu, aby uczyć się na ich sukcesach i błędach.
Bez znaczenia jest posiadanie firmy, która opracowuje unikalne i wysokiej jakości oprogramowanie, które wyprzedza konkurencję, jeśli programiści i klienci, którzy integrują techniczne dokumenty produktu, nie są w stanie ich zrozumieć.
Weź pod uwagę, że osoba czytająca dokumentację produktu może nie być zaznajomiona z zakresem możliwych rozwiązań oferowanych przez produkt lub z rynkiem (jak to zwykle bywa w przypadku technicznych produktów SaaS), a zatem musi zostać "wyedukowana" w zakresie tych rozwiązań i różnych opcji związanych z produktem.
Dokumenty produktowe, których "użyteczność generuje satysfakcję", są zgodne z logicznym wzorcem czytania dostosowanym do docelowych odbiorców. Nie ma sensu mieć najbardziej szczegółowej instrukcji na świecie, jeśli jest to 500-stronicowy plik PDF lub nie zawiera przykładu kodu i nie jest dynamicznie tworzony z możliwością wyszukiwania i innymi funkcjami. Zbieraj informacje zwrotne od użytkowników dokumentu produktu i personelu pomocy technicznej. Ustalą oni główne obszary stresu związane z raportowanymi danymi.
Konkurencyjna dokumentacja produktu to taka, która jest stale aktualizowana przy użyciu najskuteczniejszych technik wymiany informacji. Mają niesamowite funkcje, takie jak wbudowane możliwości wyszukiwania, tłumaczenia, różne wersje, osadzone obrazy, filmy i wiele więcej!
Nawet jeśli Twój przewodnik integracji jest najlepiej napisany ze wszystkich firm technologicznych, będzie pozbawiony atrakcyjności bez dodanego wideo oraz obrazów i kodów, które można kopiować i wklejać, aby ułatwić korzystanie z niego klientom znającym się na technologii, którzy kupują Twoje techniczne produkty SaaS.
Zawsze trzeba zobaczyć, jak inne firmy inicjują swoje dokumenty, aby uczyć się na ich sukcesach i błędach.
Bez znaczenia jest posiadanie firmy, która opracowuje unikalne i wysokiej jakości oprogramowanie, które wyprzedza konkurencję, jeśli programiści i klienci, którzy integrują Twoje dokumenty, nie są w stanie zrozumieć ich w całości.
Opinie na temat dokumentacji produktu
Skuteczna dokumentacja techniczna produktu zwiększa doświadczenie użytkownika końcowego poprzez dopracowanie procesu zrozumienia produktów i diagnozowanie wszelkich problemów za pomocą łatwo dostępnych pisemnych rozwiązań. Kiedy klienci ufają i rozumieją, jak korzystać z produktów, mogą wrócić do ciebie w przyszłości, gdy pojawi się taka potrzeba.
Nowe badania przeprowadzone przez SDL pokazują, że rola dokumentacji na światowych rynkach rośnie. Badanie pokazuje, że około 53% kupujących dokonuje zakupów przy użyciu literatury technicznej przed wypróbowaniem produktu. Ponadto, inne zestawione statystyki z tych badań pokazują, że 94% kupujących uważa, że posiadanie informacji o produkcie w jednym miejscu jest pomocne i przydatne. Z tego powodu każda firma kładzie obecnie równy nacisk na dokumentację produktu, jak i na jego rozwój lub testowanie.
Nawet jeśli dokumentacja ma wyznaczonego właściciela, który zarządza zespołem ds. dokumentacji, stworzył dokumentację produktu, która została zweryfikowana i oceniona pod kątem poprawy użyteczności oraz została odpowiednio zaktualizowana, nadal masz trudności ze zrozumieniem produktów technicznych przez użytkowników i konsumentów. Może to wynikać z niezdolności użytkowników/czytelników do zrozumienia, w jaki sposób dokumenty są czytane lub jakie pytania naprawdę zadają. To sprawia, że jednym z najtrudniejszych aspektów tworzenia dokumentów jest postawienie się w sytuacji czytelnika. W końcu każdy, kto tworzy dokumentację produktu, powinien mieć solidne zrozumienie produktu.
Ta wiedza może sprawić, że autor przeoczy rzeczy, które nie są tak oczywiste dla przeciętnego użytkownika. Zazwyczaj dzieje się tak, gdy coś, co jest oczywiste dla osób tworzących produkt, nie jest całkiem jasne dla osób kupujących i korzystających z produktu.
Może się to zdarzyć na wiele sposobów:
Struktura lub forma pisania: Chociaż może się to wydawać subiektywnym słowem, nawet sposób, w jaki podręcznik jest napisany, może powodować zamieszanie. Kluczowe jest zidentyfikowanie rodzaju czytelnika, który czyta dokumentację; w przeciwnym razie mogą pojawić się słowa takie jak "Programiści wolą przykłady od tekstu opisowego" lub "Nasza dokumentacja nie jest jasna pomimo obecności przykładów i wizualizacji".
Tematyka zorganizowana w podręcznikach: Czasami firmy działające na tym samym rynku opracowują standardowy format dokumentacji. Jeśli przewodniki firmowe nie są do niego dostosowane, czytelnik może mieć poczucie obcości.
Nadmierne stosowanie ukrytych terminów: W przypadku zastosowania w podręczniku, skróty mogą nie mieć większego sensu, nawet jeśli wyrażenia nie są akronimami. Trudno to dostrzec, ale niektóre słowa, takie jak "status", "identyfikator", "referencje", zawierają ukryte znaczenie ukryte jako wyraźne. Używaj konkretnych oznaczeń, takich jak "UserID" zamiast "UID".
Prawidłowe tłumaczenie: Tłumaczenie jest ogromną częścią globalnego zasięgu. Często zdarza się, że firmy tworzą źle przetłumaczone instrukcje obsługi i dokumentacje produktów, które nie pasują do kultury niektórych krajów lub po prostu słowa nie są tłumaczone w taki sam sposób, jak w języku angielskim w danym kraju. Zrozumienie tych subtelnych niuansów może sprawić, że dokumentacja produktu przejdzie długą drogę od nieczytelnych informacji do w pełni kompleksowej i przetłumaczonej dokumentacji produktu.
Aby uniknąć takich sytuacji, celem jest opracowanie rozwiązania, które gromadzi i analizuje opinie użytkowników oraz wzorce nawigacji.
Narzędzia do zbierania opinii, takie jak funkcja Vocally a Docsie, to świetny sposób na zebranie i ocenę wzorców nawigacji oraz zbadanie, w jaki sposób klienci przeglądają dokumentację produktu. Poznaj 7 złotych zasad zbierania opinii tutaj.
Informacje te mają kluczowe znaczenie dla aktualizacji i optymalizacji przewodników użytkownika, podręczników użytkownika i dokumentacji produktu, aby zapewnić klientom bardziej płynne korzystanie z produktów. Nie ma nic bardziej frustrującego niż wprowadzenie nowego produktu i odkrycie wzrostu liczby zgłoszeń do pomocy technicznej z powodu słabych instrukcji obsługi.
Jak napisać kompleksową dokumentację produktu
Wysokiej jakości dokumentacja produktu jest wciągająca, użyteczna i potężna. Twierdzę, że sprawna dokumentacja jest niezbędnym elementem dobrego zarządzania produktem. Chociaż menedżerowie produktu odgrywają ogromną rolę w rozwoju produktów, istotną częścią sukcesu jest tworzenie niesamowitej, dopracowanej dokumentacji produktu, którą nasi klienci mogą zrozumieć i wykorzystać do pogłębienia swojej wiedzy na temat naszych produktów.
Co dzieje się z większością dokumentacji produktowej?
Wielu menedżerów produktu ma awersję do tworzenia dokumentacji produktu. Dokumentacja produktu, którą znają, może nie być atrakcyjna dla klientów, chyba że dołoży się większej staranności, aby była atrakcyjna, łatwa do odczytania i powiązania z nią.
Jednak w wielu przypadkach firmy nie dokładają należytej staranności, aby stworzyć i opracować niesamowitą dokumentację produktu. Słaba dokumentacja produktu jest pisana wyłącznie w celu jej napisania. Wykorzystuje rozbudowane frazy wypełnione niejasnymi, akceptowalnymi myślami i słabym układem, aby zniechęcić odbiorców do interakcji z materiałem. Słaba dokumentacja produktu jest tworzona w celu ochrony autora przed krytyką i jest całkowitą stratą czasu. Z tego też powodu klienci nie lubią jej czytać.
Jak to naprawić i napisać lepszą dokumentację produktu, którą nasi klienci będą czytać z przyjemnością?
Doskonała dokumentacja produktu jest pisana z zamiarem jej przeczytania. Jest zwięzła. Dobra dokumentacja produktu jest dobrze sformatowana i może być przeczytana i zrozumiana przez wszystkich w firmie lub klientów w ciągu trzech minut. Unika żargonu i podaje lub odnosi się do punktu widzenia na poziomie biznesowym. Doskonała dokumentacja produktu poświęca czas na nakreślenie konkretnych przypadków użycia, które klienci mogą zrozumieć i zastosować do ulepszonego wykorzystania produktu. Angażuje czytelnika i zwraca uwagę na podstawowe kwestie z dobrze opracowanymi rozwiązaniami.
Potencjał dobrze napisanej dokumentacji produktu
W małych, średnich i dużych firmach dobrze sformatowana dokumentacja techniczna produktu może zaoszczędzić wiele czasu i pomóc pracownikom w bardziej produktywnej pracy. Jest to ogólnie prawdą w przypadku większości firm opartych na produktach, które wydają duży procent swoich budżetów na zatrudnianie pisarzy technicznych i pisanie dokumentacji technicznej produktu.
Jeśli Twoja firma zatrudnia więcej niż dwie osoby do tworzenia dokumentacji produktu, ustanowienie kultury dobrej dokumentacji jest całkowicie opłacalne. Istnieje wiele powodów, dla których warto, aby zespół tworzył, zarządzał i publikował dobrze przygotowaną dokumentację produktu, ale w poniższej sekcji zajmiemy się tym, jak skuteczna dokumentacja produktu jest tanim podejściem do poprawy jakości obsługi klienta.
Skuteczna dokumentacja produktu to tanie podejście do poprawy jakości obsługi klienta
Solidne doświadczenie klienta jest podstawą utrzymania i utrzymania lojalnych klientów. Większość kierowników projektów to optymiści - mają koncepcję, stają się entuzjastyczni, a następnie ją realizują. Chociaż pasja jest godna podziwu, a wykonanie wydaje się produktywne, posiadanie planu gry przed wykonaniem odpowiedniej dokumentacji produktu jest niezbędne.
Pierwszym krokiem po przeprowadzeniu burzy mózgów jest zainicjowanie cyklu projektowania i ustrukturyzowanie treści dokumentacji produktu w taki sposób, aby była ona stopniowo łatwa do odczytania przez klientów.
Uzyskanie informacji zwrotnych od klientów na temat bieżącej dokumentacji jest również istotnym krokiem niezbędnym do restrukturyzacji dokumentów w celu dopasowania ich do potrzeb klientów. W ten sposób kierownicy projektów mogą tworzyć, zarządzać, utrzymywać, publikować i optymalizować swoją dokumentację z percepcją i automatyzacją. Nie jest to proste i małe zadanie, a posiadanie niesamowitych narzędzi, takich jak Docsie , które automatyzują wiele procesów, aby dokumentacja produktu była skuteczna, jest niezbędne do osiągnięcia sukcesu.
Atrakcyjna, angażująca i łatwa w nawigacji dokumentacja techniczna pomaga konsumentom nauczyć się produktu w krótszym czasie, co zwiększa prawdopodobieństwo, że poprawnie skonfigurują produkt i będą go prawidłowo używać.
Wszystkie te strategie tworzenia dobrze dopracowanej dokumentacji produktu zasadniczo prowadzą do wyżej ocenianych produktów, bardziej przychylnych recenzji i większej sprzedaży; dlatego nie trzeba dodawać, że w rezultacie zwiększa się sprzedaż.
Jak stworzyć dobrze przygotowaną dokumentację produktu
Jak tworzyć skuteczną dokumentację i wspierać kulturę, w której jest ona standardem? Pisanie skutecznej dokumentacji jest wyzwaniem, ale istnieje wiele dobrych funkcji w Docsie , które mogą pomóc w procesie tworzenia dobrze przygotowanych i dynamicznych portali z dokumentacją produktów. Poniżej znajduje się ogólne podsumowanie naszego podejścia do tego zagadnienia.
Teraz zacznijmy:
**Ograniczenia stron zapewniają czytelność. Napisanie przyzwoitego dokumentu nie powinno być trudne do przeczytania i mentalnego przetworzenia. Przeciągające się, meandrujące frazy często wskazują na brak jasności. Jeśli komunikacja nie może być odpowiednio podsumowana na jednej stronie, jest to wskazówka, że menedżer produktu powinien prawdopodobnie wrócić i dalej rozbić sytuację.
Formatowanie poprawia jakość. Słabo ustrukturyzowana dokumentacja produktu zwiększa prawdopodobieństwo, że osoba ją pisząca nie będzie w stanie tego zrobić. Stwórz szablon z dobrze sformatowanymi sekcjami, tabelami i nagłówkami dokumentu. To jednorazowa inwestycja o wysokim potencjale dywidendy.
Szablony pomagają zaoszczędzić czas. O wiele łatwiej jest usunąć sekcję z szablonu niż pamiętać o jej dodaniu. Nie jest to protekcjonalne, a raczej skuteczne i oszczędzające czas. Proste sekcje, które przypominają pisarzowi o rozpoczęciu od szerokiego tła i sprecyzowaniu pomiarów lub niebezpiecznych założeń, umożliwiają bardziej precyzyjne pisanie i hierarchię decyzji.
Komentowanie i przydzielanie zadań Nie ma lepszego sposobu na zdemotywowanie pracowników do tworzenia wysokiej jakości dokumentacji niż brak uwag na ich temat. Komentarze nie muszą być bardzo inteligentne; powinny raczej wskazywać na zaangażowanie i służyć jako model. Podczas gdy idealnym rozwiązaniem jest przekazywanie opinii w formie cyfrowej, aby inni w firmie mogli skorzystać z rozmowy asynchronicznie, prosta funkcja w Docsie, która pozwala komentować i współpracować z zespołem, działa świetnie w zespole dokumentacji produktu!
Sprawdź ten blog, aby dowiedzieć się więcej o tym, jak Docsie pomaga we współpracy nad dokumentacją produktu.
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
Typy dokumentów powinny być skalowalne, aby sprostać wymaganiom Twojej firmy W miarę jak coraz więcej interesariuszy angażuje się w proces rozwoju produktu, komunikacja musi być podzielona na kilka dokumentów (szczególnie jeśli ma być spełnione kryterium "zwięzłości" jednej strony). Docsie pozwala na użyteczne i zrównoważone rozwiązanie dla rozwijających się zespołów zajmujących się dokumentacją produktów.
Użyj Docsie jako sposobu na przyspieszenie tworzenia niesamowitej dokumentacji produktu
Docsie to bardzo przydatna platforma, która pomaga w każdym aspekcie tworzenia dokumentacji produktu i portalu wiedzy. Posiada wiele wbudowanych funkcji, które sprawiają, że tworzenie, publikowanie, utrzymywanie i zarządzanie projektami tworzenia dokumentacji produktu jest naprawdę proste i przyjemne! Oto tylko kilka z wielu funkcji Docsie, które mogą pomóc w osiągnięciu tych celów:
Możliwość edycji: Docsie pozwala wszystkim naszym użytkownikom edytować dokumentację produktu po jej opublikowaniu, tworząc alternatywną wersję, która nie zostanie uruchomiona, dopóki nie będzie aktywna. Jest to niesamowite, ponieważ zespoły zarządzania produktem mogą pracować nad edycją i zmianą dokumentacji produktu, a następnie udostępniać ją, gdy będą na to gotowi, bez konieczności przeskakiwania przez obręcze HTML i CSS. Automatycznie wyrenderuje dokumentację produktu po przełączeniu przycisku, gdy będą gotowi.
Możliwość wyszukiwania: Jeśli dokumentacja produktu jest obszerna lub zawiera wiele funkcji, wtyczka wyszukiwania Docsies jest przydatnym dodatkiem, który umożliwia klientom szybkie i łatwe przeszukiwanie dokumentacji w celu znalezienia potrzebnych informacji, aby przyspieszyć proces przeglądania i przyswajania informacji z dokumentacji produktu.
Możliwość linkowania: Docsie sprawia, że dokumentacja produktu jest przyjazna dla SEO. Możesz zamieścić link zwrotny do określonych stron w witrynie swojej firmy lub po prostu napisać słowa kluczowe oparte na produktach, które będzie można wyszukać w Internecie i przyciągnąć nowych klientów szukających tego samego produktu, który posiadasz.
Możliwość posiadania różnych tłumaczeń: Najnowocześniejszy tłumacz Docsie pozwala naszym użytkownikom tłumaczyć dokumentację produktu na różne języki. Ponadto, dzięki funkcji wyboru języka Docsie, klienci mogą wybrać język, który najbardziej im odpowiada. Jest to bardzo przydatne dla globalnego zasięgu i poszerzenia bazy klientów firmy, jednocześnie budując zaufanie wśród nowo założonych klientów i klientów za granicą.
Możliwość przydzielania zadań i komentowania w celu płynnej współpracy: Docsie ma niesamowite narzędzia do współpracy z zespołem dokumentacji produktu. Możesz przypisywać komentarze, ustawiać zadania i przypisywać role, dzięki czemu możesz lepiej zarządzać tym, jakie zadania są wykonywane przez którego użytkownika, który pracuje nad projektem dokumentacji produktu z Docsie. Aby dowiedzieć się więcej, odwiedź ten blog tutaj.
Generowanie informacji zwrotnych: Możliwość poznania opinii klientów na temat dokumentacji to jedyny sposób, aby wiedzieć, jak zoptymalizować dokumentację produktu w celu dopasowania jej do potrzeb klientów, tak aby mogli oni lepiej zrozumieć dokumentację produktu i portale wiedzy Aby dowiedzieć się więcej o znaczeniu informacji zwrotnej na temat dokumentacji produktu, odwiedź mój blog tutaj.
Istnieje również wiele innych funkcji i możliwości, które Docsie pozwala Tobie i Twojemu zespołowi zarządzania produktem wykorzystać do tworzenia niesamowitej dokumentacji produktu. W tym artykule chciałbym przejść do wtyczek, które każdy portal wiedzy Docsie i dokumentacja produktu mogą dodać do swoich dokumentów, aby je ulepszyć i poprawić ich ogólną użyteczność.
Wtyczki Docsie, które sprawią, że Twój portal z dokumentacją będzie dynamiczny! Docsie posiada szereg wtyczek, których możesz użyć, aby uczynić swoją dokumentację bardziej atrakcyjną. W tym blogu podzielę je na 3 części.
W tej sekcji podzielimy wyjaśnienie tych wtyczek portalu wiedzy na trzy części.
CZĘŚĆ 1: W pierwszej części pokażemy, co pokażemy "Display Version Picker", "Display Language Picker", "Display Section Anchors" i "Display Footer Navigation".
CZĘŚĆ 2: W tej części pokażemy wtyczkę "Code Highlighting", "Search" i "Share to Social Network".
CZĘŚĆ 3: W części trzeciej pokażemy wtyczki "Podgląd obrazu", "Metadane dokumentu" i "Automatyczne podświetlanie sekcji".
Zanim przejdziemy do wtyczek, porozmawiajmy o tym, jak uzyskać do nich dostęp na platformie Docsie.
Po pierwsze, w obszarze roboczym musimy kliknąć na trzy kropki w prawym górnym rogu i otworzyć nasze konto:
Następnie w Deployments możemy uzyskać dostęp do Plugins po utworzeniu nowego Deployment poprzez "Configure a new deployment+".
Następnie kliknij "Więcej opcji", co pozwoli ci dodać te wtyczki do wdrożonej dokumentacji za pośrednictwem wbudowanego skryptu lub portalu Docsie.
Inną opcją jest dostęp do wtyczek portali wiedzy Docsie za pomocą przycisku "Aktualizuj konfigurację wdrożenia" pod już opublikowaną dokumentacją.
Otworzy się ten pulpit nawigacyjny, a następnie możesz dodawać lub usuwać wtyczki według własnego uznania, a następnie zaktualizować wdrożenie.
CZĘŚĆ 1:
Teraz, gdy już wiemy, jak uzyskać dostęp do wtyczki Docsie, przejdźmy do CZĘŚCI 1.
Aby zobaczyć część 1 samouczka wideo, sprawdź ten film tutaj:
zacznijmy od "wyboru wersji wyświetlania" i "wyboru języka wyświetlania
Gdy te dwie opcje będą aktywne, pojawią się w lewym dolnym rogu portalu wiedzy jako pływające zakładki. Umożliwiają one klientom i osobom czytającym dokumentację produktu przeglądanie dokumentów produktu w różnych językach i wersjach.
Gdy użytkownik naciśnie język w selektorze języków, zmieni całą dokumentację, którą czyta, na ten przydzielony język.
Po aktywowaniu kotwicy Wyświetl sekcję klient może mieć łącza obok każdego nagłówka, które będą zawierać łącza do określonych sekcji dokumentacji.
Za każdym razem, gdy te linki zostaną naciśnięte, część nagłówka zmieni się, a gdy klient skopiuje i wklei ten html, skieruje osobę, do której go wysyła, do tej konkretnej sekcji dokumentacji.
Następnym krokiem jest "Wyświetl nawigację w stopce
Ta wtyczka dodaje przycisk nawigacji w prawym dolnym rogu książki dokumentacji. Wygląda to mniej więcej tak.
W ten sposób klienci mogą wygodniej poruszać się po dokumentacji.
CZĘŚĆ 2:
Aby zobaczyć Część 2 samouczka wideo, sprawdź ten film tutaj:
.
W tej części pokażemy wtyczkę "Code Highlighting", "Search" i "Share to Social Network".
Zacznijmy teraz od wtyczki "Podświetlanie kodu
Ta wtyczka jest świetna dla produktów technicznych, które muszą wyrażać różne kody dla swoich klientów. Ta wtyczka pozwala klientom kopiować i wklejać przydzielony kod, aby mogli go używać w edytorze w celu ułatwienia korzystania z niego poprzez dodanie przycisku "Kopiuj".
Przejdźmy teraz do wtyczki wyszukiwania.
Po aktywacji portalu wiedzy Docsie, klienci mogą przeszukiwać dokumentację za pomocą nawigacji wyszukiwania w prawym górnym rogu portalu wiedzy.
Kliknięcie wyszukiwania spowoduje wyświetlenie zaawansowanego pulpitu nawigacyjnego, który pozwoli klientom dokładnie określić, gdzie znaleźć określone informacje na półce i w książkach.
Znacznie przyspiesza to proces, w którym klienci mogą znaleźć i uzyskać potrzebne informacje o produktach.
Następna jest wtyczka Share To Social Networks
Ta wtyczka umożliwia klientom pobieranie wyróżnionych sekcji pisemnej dokumentacji produktu i udostępnianie ich w mediach społecznościowych.
Jest to świetne rozwiązanie, ponieważ może zwiększyć ruch, nowych potencjalnych klientów i ogólne zaufanie do Twojej marki.
CZĘŚĆ 3:
Aby zobaczyć część 3 samouczka wideo, sprawdź ten film tutaj:
W części trzeciej pokażemy wtyczkę "Podgląd obrazu", "Metadane dokumentu" i "Automatyczne podświetlanie sekcji".
Zacznijmy od wtyczki podglądu obrazu
Podgląd obrazu umożliwia klientom powiększanie lub pomniejszanie obrazu dokumentacji produktu w celu jego lepszego wyświetlenia.
Następny element to "Metadane dokumentacji
Pozwala to naszym klientom zobaczyć znacznik czasu, kiedy dokumentacja produktu lub aspekty portalu wiedzy zostały zaktualizowane. Będzie on umieszczony na górze i na dole pisemnej dokumentacji.
Przyjrzyjmy się teraz wtyczce "Auto-Highlight Section Plugin".
Ta prosta wtyczka pozwala klientom śledzić, gdzie znajdują się w danej dokumentacji w portalu wiedzy.
Podświetli każdą lokalizację, w której się znajdują, w portalu wiedzy, dzięki czemu klienci yo8ru będą mogli lepiej śledzić, w której sekcji się znajdują, i łatwiej przechodzić do innych sekcji.
Wszystkie te narzędzia i nie tylko są dostarczane przez platformę Docsie. Jeśli jeszcze jej nie wypróbowałeś, sugerujemy, abyś to zrobił. Kliknij tutaj
Jeśli masz jakieś pytania, skontaktuj się z nami pod adresem hello@docsie.io.