6 najlepszych narzędzi do dokumentacji: wyselekcjonowana lista na rok 2022

Szukasz najlepszych narzędzi do dokumentacji, które pomogą Ci tworzyć najwyższej klasy zawartość dokumentacji wewnętrznej lub zewnętrznej?

Niezależnie od tego, czy tworzysz dokumentację publiczną dla konsumentów nietechnicznych, czy zawartość techniczną, taką jak dokumentacja interfejsu API oprogramowania (lub cokolwiek pomiędzy), istnieją doskonałe narzędzia do dokumentacji, które pomogą Ci zarządzać zawartością i publikować ją dla użytkowników.

W tym poście przygotowaliśmy listę sześciu najlepszych opcji, w tym rozwiązania open source i SaaS dla wszystkich budżetów (w tym bezpłatne).

W przypadku wszystkich sześciu narzędzi przedstawimy ich zalety, wady, ceny oraz sposób rozpoczęcia pracy z dokumentacją za pomocą tego narzędzia.

Wskoczmy od razu!

Sześć najlepszych narzędzi do dokumentacji

1. Heroiczna baza wiedzy
2. GitBook
3. Dokument360
4. Przeczytaj dokumentację
5. Pojęcie + Silnik.so
6. Sok Pomocy

1. Heroiczna baza wiedzy

Heroic Knowledge Base to narzędzie dokumentacji typu open source, które jest oparte na popularnym oprogramowaniu WordPress, które również jest open-source.

Możesz zainstalować Heroic Knowledge Base jako wtyczkę do WordPress, aby natychmiast zmienić swoją witrynę WordPress w centrum dokumentacji.

To, jak utworzysz swoją witrynę, zależy od Ciebie — możesz utworzyć zupełnie nową witrynę WordPress, która jest wyłącznie do dokumentacji, lub możesz zainstalować Heroic Knowledge Base na istniejącej witrynie WordPress, aby dodać funkcję dokumentacji do tej witryny.

Do tworzenia treści możesz użyć elastycznego edytora bloków WordPress wraz z wbudowanym systemem weryfikacji wersji WordPress.

Heroic Knowledge Base dodaje również własne dedykowane bloki, dzięki czemu można łatwo dodawać objaśnienia, ostrzeżenia i inne informacje.

Dostajesz również narzędzia, dzięki którym część lub całość dokumentacji jest prywatna, w zależności od tego, czy tworzysz dokumentację publiczną, czy wewnętrzną.

Heroic Knowledge Base oferuje również mnóstwo funkcji, które zapewnią odwiedzającym wspaniałe wrażenia i zoptymalizują dokumentację:

• Wyszukiwanie AJAX w czasie rzeczywistym z sugestiami na żywo.
• Kategorie i tagi do organizowania artykułów.
• Wbudowana analityka do śledzenia wyszukiwań, wyświetleń, skuteczności artykułów i transferów do kanałów wsparcia na żywo.

Ponieważ jest oparty na WordPressie, możesz również rozszerzyć swoją dokumentację za pomocą innych wtyczek. Na przykład możesz użyć bezpłatnej wtyczki Multicollab, aby dodać do edytora treści komentowanie i współpracę w stylu Dokumentów Google.

Korzyści

• Nieograniczona liczba użytkowników, artykułów, kategorii itd . . Zasadniczo nie ma arbitralnych ograniczeń, jakie zwykle napotykasz w narzędziach dokumentacji SaaS.
• Elastyczny . Heroic Knowledge Base zawiera mnóstwo wbudowanych funkcji, które pomogą Ci skonfigurować dokumentację, a także w razie potrzeby możesz zainstalować inne wtyczki WordPress, takie jak dodawanie funkcji współpracy.
• Pełna własność danych . Wszystkie Twoje dane pozostają w 100% na Twoich własnych serwerach przez cały czas.
• Otwarte źródło . Zarówno WordPress, jak i Heroic Knowledge Base są open-source.

Wady

• Jeśli z jakiegoś powodu nie chcesz korzystać z WordPressa, pamiętaj, że Heroic Knowledge Base działa tylko z WordPressem.

cennik

Heroic Knowledge Base zaczyna się od 149 USD do wykorzystania na jednej stronie internetowej i rocznej pomocy technicznej i aktualizacji. Zachowasz dostęp do oprogramowania na zawsze bez dodatkowych kosztów, ale będziesz musiał odnowić licencję, aby nadal otrzymywać wsparcie i aktualizacje po pierwszym roku.

Będziesz także potrzebować witryny WordPress, która może kosztować trochę pieniędzy, jeśli nie masz jeszcze dostępu do hostingu witryny obsługującego WordPress.

Jak zacząć

Oto jak skonfigurować centrum dokumentacji za pomocą Heroic Knowledge Base:

1. Utwórz witrynę WordPress, która będzie stanowić podstawę swojego centrum (jeśli jeszcze tego nie zrobiłeś).
2. Kup i zainstaluj wtyczkę Heroic Knowledge Base.
3. Skonfiguruj zachowanie centrum dokumentacji za pomocą ustawień ( Heroic KB → Settings )
4. Dodaj artykuły za pomocą elastycznego edytora bloków.

Możesz także dodać inne poprawki, takie jak tworzenie witryny intranetowej, ograniczanie dostępu dla zalogowanych użytkowników lub wymaganie hasła w celu przeglądania dokumentacji (co może być przydatne w przypadku dokumentacji wewnętrznej).

2. GitBook

Jak sama nazwa wskazuje, GitBook to narzędzie do dokumentacji, które jest bardziej nastawione na zespoły programistyczne, które muszą tworzyć dokumentację publiczną lub prywatną.

Na przykład możesz zsynchronizować GitBook z repozytorium GitHub lub GitLab, które zawiera pliki Markdown, aby w ten sposób utworzyć dokumentację. Jednak nie jesteś zmuszony używać Git tylko do korzystania z GitBook, a także możesz tworzyć zawartość za pomocą intuicyjnego edytora lub importować ją z innych źródeł, takich jak pliki przecen, dokumenty Word i inne.

Aby uporządkować swoją dokumentację, możesz użyć „spacji” (tj. jednej unikalnej bazy wiedzy) i „kolekcji” (tj. jednej kategorii w bazie wiedzy).

Niektóre inne godne uwagi funkcje obejmują:

• Kontrola wersji.
• Edycja i współpraca zespołu na żywo.
• Bogate embedy w edytorze treści.
• Łatwy eksport PDF.

Korzyści

• Korzystaj ze znanych technicznych przepływów pracy . W przypadku zespołów technicznych GitBook umożliwia korzystanie z narzędzi, które już znasz (takich jak Git). Używa również terminów technicznych, takich jak „gałęzie” i „prośby o zmianę” w przypadku edycji.
• Funkcje współpracy . Może to być przydatne, jeśli wiele osób pracuje nad tym samym dokumentem (może nawet w tym samym czasie).
• Bezpłatnie dla organizacji non-profit. Jeśli jesteś organizacją non-profit lub prowadzisz projekt open-source, możesz korzystać z GitBooka za darmo.

Wady

• Techniczne . Jeśli nie tworzysz dokumentacji oprogramowania, GitBook może wydawać się nieco skomplikowany. Osoby, które chcą tworzyć dokumentację nietechniczną, prawdopodobnie będą chciały szukać gdzie indziej.

cennik

GitBook jest darmowy do użytku indywidualnego, organizacji non-profit i projektów open-source. Plany komercyjne zaczynają się od 8 USD za użytkownika miesięcznie, przy minimum 5 użytkownikach. Najtańszy plan to 40 USD miesięcznie.

Jak zacząć korzystać z heroicznej bazy wiedzy

Aby rozpocząć, wystarczy zarejestrować konto GitBook i rozpocząć budowanie. Możesz zsynchronizować się z repozytorium na GitHub lub zbudować od podstaw za pomocą edytorów treści GitBook.

3. Dokument360

Document360 to narzędzie dokumentacji SaaS, które umożliwia tworzenie własnej wewnętrznej lub skierowanej do przodu bazy wiedzy.

Ze względu na podejście SaaS bardzo łatwo jest zacząć. Wystarczy zarejestrować konto i rozpocząć tworzenie dokumentacji za pomocą przyjaznego dla użytkownika interfejsu.

Możesz tworzyć treści za pomocą prostego edytora WYSIWYG z obsługą Markdown. Uzyskasz również dostęp do narzędzi do współpracy i kontroli wersji, co jest przydatne, jeśli pracujesz z zespołem.

W interfejsie użytkownicy otrzymają dobrze zaprojektowany interfejs do przeglądania treści, w tym przydatne elementy, takie jak sugestie wyszukiwania na żywo, automatyczny spis treści i inne.

Korzyści

• Łatwa konfiguracja . Aby stworzyć dokumentację, wystarczy zarejestrować konto i zacząć pisać.
• Hostowane dla Ciebie . Document360 zajmuje się hostingiem i utrzymaniem dokumentacji za Ciebie, więc nigdy nie musisz zadzierać z aktualizacjami ani niczym innym.
• Cechy produktywności . Otrzymasz dostęp do kilku fajnych funkcji, takich jak automatyczne przypomnienia o recenzjach, powiadomienia o wydarzeniach z bazy wiedzy i nie tylko.

Wady

• Kosztowny. Najtańszy płatny plan to już 119 USD miesięcznie i obejmuje tylko ograniczone funkcje.
• Ograniczenia . Jeśli potrzebujesz więcej kont zespołu lub baz wiedzy, musisz dodatkowo zapłacić. Na przykład plan startowy obejmuje tylko pięć kont zespołu. Jeśli chcesz więcej, zapłacisz 19 USD miesięcznie za konto.

cennik

Document360 to narzędzie SaaS, więc będziesz płacić miesięczną lub roczną opłatę tak długo, jak chcesz z niej korzystać. Plany zaczynają się od 119 USD za projekt miesięcznie, plus 39 USD za dodatkową wersję bazy wiedzy i 19 USD za każde konto zespołu poza pięcioma uwzględnionymi kontami.

Dostępny jest również bezpłatny plan, który umożliwia utworzenie do 50 artykułów z 1 GB pamięci i ograniczonym dostępem do funkcji.

Jak zacząć korzystać z Document360

Document360 to narzędzie dokumentacji SaaS, co oznacza, że ​​aby rozpocząć, wystarczy zarejestrować konto.

Dostępny jest 14-dniowy bezpłatny okres próbny, dzięki któremu możesz bezpłatnie korzystać ze wszystkich funkcji.

4. Przeczytaj dokumentację

Read the Docs to narzędzie do tworzenia dokumentacji stworzone specjalnie z myślą o oprogramowaniu lub dokumentacji technicznej.

Umożliwia zarządzanie zawartością i wersjonowaniem za pomocą Git, a następnie łatwe wdrażanie w przyjaznym dla użytkownika interfejsie frontendu. Takie podejście oznacza, że ​​jest naprawdę dostępne tylko dla programistów… ale ma to sens, biorąc pod uwagę, że koncentruje się na tworzeniu dokumentacji technicznej.

W zależności od używanej wersji możesz również uzyskać dostęp do niektórych lub wszystkich następujących funkcji:

• Analytics, aby zobaczyć, czego szukają i czytają użytkownicy.
• Wyniki wyszukiwania na żywo i sugestie.
• Wiele jednoczesnych kompilacji. Na przykład jedna kompilacja do produkcji, a druga do wersji beta lub jedna do wersji 1.0, a druga do wersji 2.0.
• Łatwy eksport do formatu PDF, HTML lub epub.
• Logowanie jednokrotne przez Google Workspace lub dostawcę VCS (GitHub, GitLab lub Bitbucket).

Korzyści

• Korzystaj z narzędzi programistycznych . Używając narzędzi takich jak Git do zarządzania dokumentacją, Read the Docs próbuje wbudować się w istniejące przepływy pracy programistów.
• Silna wersja . Git ułatwia zarządzanie wersjami, a także umożliwia publikowanie wielu wersji dokumentów jednocześnie, co jest świetne, jeśli użytkownicy mogą używać różnych wersji Twojego oprogramowania.

Wady

• Bardziej złożona konfiguracja . Read the Docs jest nieco bardziej skomplikowany w konfiguracji niż inne narzędzia dokumentacji, ponieważ musisz pracować przez Git. Jednak biorąc pod uwagę, że skupia się na dokumentacji technicznej, typy osób korzystających z funkcji Read the Docs nie powinny mieć problemów.
• Tylko dla dokumentacji technicznej . Jeśli nie tworzysz oprogramowania/dokumentacji technicznej, wybierz inne narzędzie do tworzenia dokumentacji, ponieważ Read the Docs nie jest dla Ciebie.

cennik

Jeśli masz projekt typu open source, funkcja Read the Docs umożliwia bezpłatne tworzenie i hostowanie dokumentacji. W rzeczywistości Read the Docs twierdzi, że udostępnia bezpłatną dokumentację dla ponad 240 000 projektów open source.

Dla firm komercyjnych dostępna jest również płatna usługa Read the Docs for Business, która zaczyna się od 50 USD miesięcznie. Wszystkie plany obejmują nieograniczoną liczbę projektów i użytkowników – głównymi ograniczeniami są dostępne funkcje i liczba jednoczesnych kompilacji, które możesz mieć.

Jak zacząć czytać dokumenty

Read the Docs oferuje dwa sposoby na napisanie własnej dokumentacji:

1. Dokumentacja
2. Sfinks

Gdy użyjesz tych narzędzi do utworzenia repozytorium Git z zawartością Twojej dokumentacji, funkcja Read the Docs automatycznie zaimportuje repozytorium, aby zbudować Twoją dokumentację.

5. Pojęcie + Silnik.so

Notion jest tutaj trochę podkręcony, ponieważ nie jest specjalnie zbudowany do dokumentacji. Jednak przy odpowiedniej konfiguracji może być doskonałym narzędziem do obsługi wszelkiego rodzaju dokumentacji.

Jeśli nie znasz Notion, jest to w zasadzie uniwersalne narzędzie do obsługi wszelkiego rodzaju wiedzy, danych, zarządzania projektami i wielu innych.

Możesz go używać do wielu różnych rzeczy, w tym do tworzenia wszelkiego rodzaju dokumentacji. Minusem jest jednak to, że Notion sam w sobie nie koncentruje się na publikowaniu tych informacji na stronie internetowej, na której inne osoby mogą wchodzić z nią w interakcje.

Tutaj wkracza Engine.so. Dzięki Engine.so ( usługa firmy zewnętrznej ) możesz publikować zawartość Notion we własnej witrynie internetowej, aby łatwo stworzyć własne centrum dokumentacji. Możesz zobaczyć przykład tego, jak to wygląda w dokumentacji Engine.so.

Korzyści

• Unikalne sposoby prezentacji informacji . Korzystanie z Notion zapewnia dużą elastyczność, której możesz nie uzyskać w przypadku węższych narzędzi dokumentacji. Na przykład, możesz użyć wielu bloków Notion w interesujący sposób.
• Łatwy w użyciu . W przeciwieństwie do narzędzi opartych na Git to podejście jest łatwe zarówno dla użytkowników technicznych, jak i nietechnicznych.
• Niedrogie . Chociaż nie ma darmowego planu, to podejście powinno być dostępne w większości przypadków użycia.

Wady

• Nie jest przeznaczony do dokumentacji . Chociaż Notion świetnie sprawdza się w przypadku dokumentacji, nie jest to jego jedyny cel, tak jak w przypadku innych narzędzi do dokumentacji na tej liście. Jeśli planujesz mieć setki artykułów, być może wolisz bardziej wyspecjalizowane narzędzie.
• Ograniczona kontrola wersji. Takie podejście nie zapewnia silnej kontroli wersji. Jeśli zapłacisz za Notion, możesz uzyskać 30-dniową historię wersji, ale nie jest ona tak silna jak Git czy system WordPress, który otrzymujesz z Heroic Knowledge Base.

cennik

Notion ma darmowy plan, który powinien działać dobrze w podstawowych przypadkach użycia. Istnieje jednak szansa, że ​​możesz chcieć zapłacić w zależności od konkretnych potrzeb.

Aby jednak zmienić zawartość Notion w publiczne centrum dokumentacji, musisz zapłacić za Engine.so. Engine.so kosztuje 19 USD miesięcznie za maksymalnie 300 stron lub 49 USD miesięcznie za maksymalnie 1000 stron. Możesz to przetestować w 14-dniowym bezpłatnym okresie próbnym.

Jak zacząć korzystać z Notion

Oto jak tworzyć dokumentację przy użyciu tej konfiguracji:

1. Zarejestruj się, aby założyć konto Notion.
2. Utwórz swoją dokumentację za pomocą Notion. Możesz znaleźć gotowe szablony Notion dla treści dokumentacji, takie jak te szablony z Beestat.
3. Zarejestruj konto Engine.so.
4. Opublikuj swoją dokumentację Notion we własnej niestandardowej witrynie internetowej/centrum dokumentacji za pomocą Engine.so.

6. Sok Pomocy

Podobnie jak Document360, Helpjuice to kolejna popularna baza wiedzy i narzędzie dokumentacji SaaS.

Pomaga w łatwym tworzeniu dowolnego rodzaju dokumentacji za pomocą prostego edytora tekstu, w tym opcji importowania z dokumentów programu Word w celu zaoszczędzenia czasu.

Otrzymasz również dostęp do szeregu funkcji do tworzenia efektywnej dokumentacji:

• Wyniki/sugestie wyszukiwania błyskawicznego.
• Analytics do śledzenia wyszukiwań, wyświetleń stron i wielu innych.
• Możliwość publikowania wielu wersji dokumentacji.
• Poziomy dostępu użytkowników do kontrolowania, kto może zobaczyć różne artykuły.
• Funkcje współpracy, w tym komentarze w edytorze.

Korzyści

• Łatwa konfiguracja . Aby stworzyć dokumentację, wystarczy zarejestrować konto.
• Hostowane dla Ciebie . Helpjuice zajmuje się hostingiem i utrzymaniem Twojej dokumentacji za Ciebie, więc nigdy nie musisz zadzierać z aktualizacjami ani niczym innym.
• Brak planów z zablokowanymi funkcjami . Chociaż Helpjuice nie ma darmowego planu, wszystkie jego płatne plany zapewniają dostęp do wszystkich funkcji.

Wady

• Drogie . Najtańszy plan zaczyna się od 120 USD miesięcznie i może wynosić do 500 USD miesięcznie.
• Limity użytkowników . Jeśli masz duży zespół, Helpjuice może być drogi. Na przykład, jeśli masz więcej niż 60 użytkowników, potrzebujesz abonamentu 500 USD miesięcznie.

cennik

Płatne plany Helpjuice zaczynają się od 120 USD miesięcznie za wszystkie funkcje i do czterech użytkowników. Stamtąd plany rosną w zależności od liczby potrzebnych użytkowników, dodając do 500 USD miesięcznie za nieograniczoną liczbę użytkowników.

Unikalną rzeczą jest to, że masz dostęp do wszystkich funkcji we wszystkich planach, podczas gdy coś takiego jak Document360 blokuje niektóre funkcje za planami wyższego poziomu.

Możesz także przetestować wszystko w 14-dniowym bezpłatnym okresie próbnym.

Jak zacząć korzystać z Helpjuice

Aby rozpocząć, wszystko, co musisz zrobić, to zarejestrować konto Helpjuice i zacząć dodawać swoje treści.

Jakie jest najlepsze narzędzie do dokumentacji dla Twoich potrzeb?

Ostatecznie wybór najlepszego narzędzia do tworzenia dokumentacji naprawdę zależy od Twoich konkretnych potrzeb, budżetu i poziomu wiedzy.

Oto kilka typowych pytań, które warto sobie zadać, aby zawęzić wyszukiwanie:

• Potrzebujesz rozwiązania z własnym hostingiem, czy nie masz nic przeciwko korzystaniu z narzędzia SaaS?
• Podobnie, czy chcesz rozwiązania typu open source, czy nie masz nic przeciwko korzystaniu z narzędzia o zamkniętym kodzie źródłowym?
• Tworzysz dokumentację bardzo techniczną (np. dokumentację API) lub dokumentację bardziej skierowaną do konsumenta?
• Czy podoba Ci się pomysł wykorzystania Git do kontroli wersji/zarządzania treścią, czy też wolisz mieć dedykowany system zarządzania wiedzą?
• Jaki jest twój budżet? Czy możesz płacić stałą miesięczną opłatę, czy chcesz coś za darmo lub jednorazową płatność?

Odpowiadając na te pytania, powinieneś dobrze wiedzieć, które narzędzie dokumentacji jest najlepszym narzędziem do Twoich potrzeb.

Jeśli nie wiesz, od czego zacząć, uważamy, że Heroic Knowledge Base może zaspokoić potrzeby większości firm. Oferuje ekonomiczne podejście typu open source, które zapewnia pełną własność danych w cenie niższej niż większość innych narzędzi.

Ale jednocześnie nadal masz dostęp do mnóstwa funkcji do tworzenia najwyższej jakości dokumentacji, takich jak sugestie wyszukiwania na żywo i szczegółowe analizy. Otrzymasz również dostęp do całego ekosystemu WordPress, jeśli chcesz jeszcze większej elastyczności.

Aby dowiedzieć się więcej i zacząć, przejdź do strony produktu Heroic Knowledge Base.