12 najlepszych przykładów dokumentacji

Czy Twoi klienci mogą samodzielnie znaleźć rozwiązania swoich problemów z Twoimi produktami lub usługami? I czy potrafią to zrobić szybko i łatwo?

Odpowiedź twierdząca na oba te pytania jest dużą częścią zapewniania doskonałej obsługi klienta i poprawy wskaźnika zadowolenia klienta. Dlatego tak ważne jest posiadanie dokumentacji, która pomaga klientom znaleźć odpowiedzi na ich pytania, nie czekając na odpowiedź kogoś z personelu.

Jednak pisanie dokumentacji online od podstaw to nie lada wyczyn. Warto przyjrzeć się markom, które zrobiły to z powodzeniem przed Tobą. Dlatego w tym poście przyjrzymy się różnym kategoriom dokumentacji i najlepszym przykładom dokumentacji w tych kategoriach. Zobaczymy również, jak możesz podążać tropem najlepszej dostępnej dokumentacji i samodzielnie tworzyć własną dokumentację. Zacznijmy.

Rodzaje dokumentacji

Zanim przejdziemy do przykładów dokumentacji, ważne jest, aby poznać różne typy dokumentacji. Pomoże Ci to zrozumieć typy, które będą miały największy sens dla Twojej firmy.

Dokumentacja użytkownika

Dokumentacja użytkownika to tworzenie podręczników użytkownika, przewodników szybkiego startu, samouczków, często zadawanych pytań i innych materiałów instruktażowych, aby zapewnić użytkownikom końcowym produktu lub usługi pomoc, której potrzebują, aby w pełni wykorzystać jego potencjał.

Dokumentacja programisty

Jak można się domyślić, dokumentacja dla programistów jest przeznaczona dla programistów, aby zrozumieć wszystkie aspekty tego, w jaki sposób mogą wykorzystać lub zintegrować daną bibliotekę oprogramowania lub usługę, zwykle za pośrednictwem interfejsu API (interfejsu programowania aplikacji). Dokumentacja dla programistów zawiera materiały, takie jak przypadki użycia, uwierzytelnianie, informacje dotyczące rozwiązywania problemów i tak dalej. Na ogół będzie składać się z bardziej technicznych pism niż dokumentacja użytkownika skierowana do klienta.

Dokumentacja techniczna

Dokumentacja techniczna leży gdzieś pośrodku dokumentacji użytkownika i dokumentacji dewelopera i zwykle potrzebuje pisarza technicznego. Ma na celu wyjaśnienie instrukcji technicznych lub koncepcji związanych z produktem w zrozumiały sposób, który powinien zrozumieć nawet nie-programista.

Dokumentacja projektu

Dokumentacja projektowa obejmuje kluczowe szczegóły dotyczące projektu. Polega na stworzeniu kompleksowej dokumentacji wyjaśniającej, co jest potrzebne w trakcie projektu do jego prawidłowego wykonania. Niektóre przykłady dokumentacji projektowej obejmują propozycje projektów, plany projektów, przypadki biznesowe, raporty o stanie i tak dalej.

Korzyści z dokumentacji

Rozumiemy. Jesteś zajęty prowadzeniem firmy, a ostatnią rzeczą, jakiej chcesz, jest ciągłe dokumentowanie takich rzeczy, jak raporty o stanie, przewodniki i tak dalej. Jednak gdy niespodziewane problemy pojawią się znikąd (a tak się stanie), będziesz zadowolony, że Ty i Twoi użytkownicy macie dokumentację, na której można się oprzeć. Oto kluczowe zalety priorytetyzacji odpowiedniej dokumentacji.

Wiedza w jednym miejscu

Szacuje się, że przeciętny pracownik wiedzy spędza około 2,5 godziny dziennie na poszukiwaniu informacji. Skuteczna dokumentacja oszczędza każdemu znaczną ilość czasu, gromadząc wszystkie niezbędne informacje w jednym miejscu.

Zwiększ produktywność

Dokumentacja zapewnia wykonanie zadań nawet w przypadku nieoczekiwanych zdarzeń, takich jak nieobecność członka zespołu lub ponowne pojawienie się znanego problemu. Jesteś w stanie utrzymać koła w ruchu bez marnowania zasobów na śledzenie poświadczeń, szczegółów i nie tylko.

Zwiększ satysfakcję

Dokumentacja pomaga utrzymać zadowolenie i zadowolenie klientów. Pokazując im, jak uzyskać jak najwięcej korzyści ze swojego produktu, dokumentacja zmniejsza wskaźnik odpływów klientów i zwiększa wartość życiową klienta.

Pomijając korzyści, przejdźmy od razu do najlepszych przykładów dokumentacji dla każdego z czterech typów dokumentacji.

Wtyczka heroicznej bazy wiedzy

Zbuduj bazę wiedzy i pomóż swoim klientom pomóc sobie.

Pobierz wtyczkę

Przykłady dokumentacji użytkownika

Google

Google nie wymaga przedstawiania. Oferuje setki produktów, z których każdy posiada własną dokumentację. To, co wyróżnia dokumentację produktu Google, to połączenie statycznych odpowiedzi i forów społeczności, na których użytkownicy mogą przesyłać opinie i zadawać pytania.

Inne godne uwagi cechy dokumentacji Google obejmują:

• Użytkownicy mogą pomagać sobie nawzajem w nietypowych zapytaniach. Daje to klientom większą szansę na to, by byli lepiej słyszani i zgłaszali wątpliwości.
• Funkcja Upvote jest świetna, aby sprawdzić, czy inne osoby również borykają się z tymi samymi problemami i zebrać wsparcie dla najważniejszych problemów i pomysłów.
• Klienci mogą również subskrybować aktualizacje w dyskusji lub publikować komentarz, aby wnieść dodatkowy punkt widzenia.

Skype

Skype to popularne oprogramowanie firmy Microsoft do spotkań wideo, używane do różnych celów, takich jak spotkania biznesowe, sesje edukacyjne i osobiste czaty. Skype stanowi doskonały przykład dokumentacji, ponieważ dokumentacja oprogramowania zawiera przyjazne dla użytkownika funkcje, takie jak różne opcje nawigacji i sortowania.

Inne rzeczy, na które należy zwrócić uwagę, to:

• Użytkownicy mogą wskazać, czy uznali dokument za pomocny, czy nie, i podzielić się swoją opinią.
• Funkcje, takie jak bułka tarta i spis treści, ułatwiają nawigację po dokumentacji.

Apple iPhone

IPhone firmy Apple jest znany ze swojej intuicyjności i przyjaznych dla użytkownika funkcji, ale to nie jest wymówka, by ignorować odpowiednią dokumentację. Na szczęście Apple to rozumie, a jego dokumentacja jest tak prosta i łatwa w nawigacji jak iPhone.

Warte uwagi aspekty dokumentacji iPhone'a obejmują:

• Istnieje możliwość wyboru wersji iOS, którą użytkownik aktualnie zainstalował. Pomaga to użytkownikom końcowym upewnić się, że instrukcje są dla nich dokładne i odpowiednie.
• Spis treści został wykorzystany do odniesienia się do innych funkcji i zrzutów ekranu dotyczących poszczególnych urządzeń.
• Użytkownicy mogą skontaktować się bezpośrednio z zespołem pomocy technicznej, jeśli dokument nie odpowiada na ich zapytanie.

Przykłady dokumentacji dla programistów

Dokumenty Dockera

Docker to otwarta platforma do tworzenia, uruchamiania i dostarczania aplikacji. Pozwala oddzielić aplikacje od infrastruktury w celu szybkiego dostarczenia oprogramowania. To, co daje dokumentacji Dockera niesamowity początek, to możliwość przełączania się między trybem nocnym a trybem dziennym.

Inne czynniki, które sprawiają, że ta dokumentacja jest świetna, to:

• Na końcu różnych rozdziałów znajdują się sekcje podsumowania i ściągawki. Te sekcje pomagają wzmocnić koncepcje, które użytkownik mógł przeoczyć.
• Linki wewnętrzne znajdują się na wszystkich stronach dokumentacji, aby ułatwić użytkownikowi rozwinięcie części informacji.
• Umożliwia powrót do wymaganej strony lub rozdziału, który jest niezbędny do zrozumienia spostrzeżeń zawartych na bieżącej stronie.

Centrum deweloperów Heroku

Heroku oferuje wydajną i łatwą usługę wdrażania aplikacji dla programistów. A jego centrum programistyczne ma piękną konfigurację dokumentacji. Największą atrakcją tej dokumentacji jest łatwość przejścia na inny język.

Oto kilka rzeczy, na które warto zwrócić uwagę w dokumentacji Heroku.

• Podaje sekwencyjne kroki dla różnych języków programowania, wraz z ich odpowiednimi pakietami.
• Dostępne są zasoby dotyczące innych narzędzi i integracji, które są często używane razem z Heroku, na przykład używanie Github jako repozytorium kodu.

Dokumenty Twilio

Twilio jest czołowym dostawcą interfejsów API, który pomaga firmom i programistom w niestandardowych rozwiązaniach komunikacyjnych od 2008 roku. Dokumentacja dla programistów Twilio jest dziełem sztuki, a jej elegancka, dwupanelowa konstrukcja zapewnia wszystko, co musisz wiedzieć od razu. Lewy panel zawiera proste wyjaśnienia, a prawy panel zawiera przydatne fragmenty kodu.

Co jeszcze sprawia, że ​​ta dokumentacja jest świetna? Następujące:

• Dokumentacja dla programistów Twilio ma elegancki styl czcionki i kontrastujące hiperłącza. Cały interfejs jest bardzo przyjemny dla oka.
• Istnieje kilka fragmentów kodu źródłowego, które programiści mogą od razu kopiować i wklejać, aby zaoszczędzić czas i kłopoty.
• Twilio zapewnia niesamowity poziom głębi nawet dla początkujących, z tematami takimi jak „Czym w ogóle jest REST API?”

Przykłady dokumentacji technicznej

Monitor kampanii

Narzędzie do e-mail marketingu Campaign Monitor to świetny przykład dobrze wykonanej dokumentacji technicznej. Koncentruje się na funkcji wyszukiwania, a następnie na przejrzystym, odpowiednio ustrukturyzowanym zbiorze artykułów, aby pomóc klientom.

Co jeszcze sprawia, że ​​jest to dobra dokumentacja?

• Artykuły są podzielone na kategorie, które odpowiadają funkcjom oprogramowania do automatyzacji poczty e-mail.
• Wskaźnik stanu aplikacji to sprytny ruch, który informuje klientów, czy problem, z którym się borykają, pochodzi z Monitora kampanii, łagodząc stres.

Kanwa

Canva oferuje narzędzia do projektowania graficznego do użytku osobistego i zawodowego, których można również używać na urządzeniach z systemem iOS i Android. Doświadczenie Canva w zakresie projektowania jest widoczne na własnych pięknych stronach dokumentacji. Od funkcji wyszukiwania po kategorie artykułów, użytkownicy mają jasny wybór, aby szybko znaleźć właściwe rozwiązanie.

Dokumentacja Canva działa, ponieważ:

• Strona główna zawiera świetną mieszankę najlepszych artykułów, kategorii i innych opcji pomocy.
• „Popularne wyszukiwania” pomagają klientom zrozumieć, jakiego rodzaju frazy mogą wyszukiwać, aby skutecznie korzystać z funkcji wyszukiwania.

Dropbox

Jeśli korzystasz z usługi przechowywania w chmurze, na pewno słyszałeś o Dropbox. W przypadku rozwiązania SaaS, takiego jak Dropbox, mądrą decyzją jest rozwiązywanie najczęstszych problemów bezpośrednio na stronie głównej.

Dodatkowe najważniejsze informacje w dokumentacji Dropbox obejmują:

• Wykorzystanie atrakcyjnych ilustracji wzmacnia przyjazną atmosferę marki, która ma duży wpływ na pocieszenie osób z problemami.
• Integracja ze społecznością Dropbox ułatwia interakcje między użytkownikami i daje dodatkową możliwość szukania pomocy.

Przykłady dokumentacji projektowej

Karta Projektu Uniwersytetu Guelph

Karta projektu to oficjalny dokument autoryzacji projektu, który zawiera szczegółowe informacje na temat zakresu projektu, celów i rozwoju, a także ról i obowiązków każdego interesariusza.

Karta projektu University of Guelph jest doskonałym przykładem dokumentacji. Obejmuje wszystkie aspekty istotne dla karty projektu w łatwo zrozumiałym układzie tabeli.

Szablon planu projektu dla MS Word

Innym przykładem dokumentacji projektowej jest prosty szablon planu projektu dla MS Word. Umożliwia dodawanie zadań, śledzenie dat rozpoczęcia i zakończenia, a także monitorowanie statusu każdego zadania.

Raport o stanie projektu

Raport o statusie projektu to cotygodniowy raport przygotowywany przez kierownika projektu w celu przekazania aktualnego stanu projektu wszystkim interesariuszom. Na podstawowym poziomie obejmuje zakres, budżet, harmonogram, zagadnienia i ryzyka. Oto przykład.

Dodawanie dokumentacji do Twojej witryny

Pisanie i prowadzenie dokumentacji może być zniechęcające. Jednak każdy dokument, który napiszesz, może pomóc dziesiątkom tysięcy klientów uzyskać odpowiedzi na ich pytania bez potrzeby pomocy człowieka.

Jeśli jesteś gotowy, aby zacząć, rozważ użycie Heroic KB, aby dodać dokumentację do swojej witryny. Jest to łatwa w użyciu wtyczka bazy wiedzy, która integruje świetnie wyglądającą dokumentację z Twoją witryną WordPress. Główne cechy Heroic KB to:

Natychmiastowa integracja motywów : dzięki strukturze opartej na szablonach, Heroic Knowledge Base daje Ci kontrolę nad wyglądem i działaniem Twojej dokumentacji. Otrzymasz również uwagi dotyczące integracji motywów, dzięki czemu Heroic KB jest jedną z najbardziej elastycznych wtyczek bazy wiedzy dla WordPress.

Natychmiastowe odpowiedzi : błyskawiczne wyszukiwanie AJAX umożliwia klientom znalezienie tego, czego potrzebują w ciągu kilku sekund.

Wbudowana analityka : uzyskaj wgląd w to, jak dobrze Twoja baza wiedzy pomaga użytkownikom. Możesz także zbierać opinie na temat artykułów, aby wskazać te, które pomagają Twoim użytkownikom.

Łatwa organizacja : Heroic KB jest wyposażony w kolejność kategorii przeciągnij i upuść, dzięki czemu możesz uporządkować wszystko po swojemu.

Kontrola dostępu użytkownika : Chroń i ukrywaj artykuły z różnych ról użytkowników.

Obsługa załączników plików : udostępnij odwiedzającym pliki do pobrania w swoich artykułach.

Obsługa widżetów : istnieją trzy widżety do wyświetlania artykułów, kategorii i autorów z bazy wiedzy w Twojej witrynie.

Przyjazny dla programistów : Heroic KB działa po wyjęciu z pudełka z większością dobrze zakodowanych motywów, a także domyślnie responsywnym stylem.

Obsługa języków : wtyczka jest gotowa do tłumaczenia z kompatybilnością z WPML i oferuje pełną obsługę lokalizacji.

Doskonała obsługa klienta : Zespół Heroic KB jest zawsze chętny i szybki do pomocy w przypadku napotkania jakichkolwiek problemów.

Jako użytkownik WordPressa możesz oczywiście po prostu dodawać artykuły jako posty na blogu. Ale korzystanie z określonej wtyczki KB ma wiele zalet. Znacznie ułatwia zarządzanie dokumentacją, a użytkownikom umożliwia przeszukiwanie dokumentacji oddzielnie od innych treści.

Inną opcją jest użycie dedykowanego motywu bazy wiedzy, ale jest to dobry pomysł tylko wtedy, gdy cała witryna jest Twoją bazą wiedzy. W przypadku dodawania bazy wiedzy do istniejącej witryny WordPress, wtyczka jest zdecydowanie najlepszym rozwiązaniem.

Jak widać na powyższych przykładach, świetna dokumentacja ma ogromny potencjał nie tylko do zadowolenia obecnych klientów, ale także do szkolenia pracowników i przyciągania potencjalnych klientów. Wysiłki, które włożysz, aby dodać dokumentację do swojej witryny, będą procentować w nadchodzących latach. Zacznij więc od Heroic KB już dziś.