Jak zbudować narzędzie do tworzenia pomocy za pomocą WordPress

Dobry pisarz techniczny nigdy nie jest daleko od swojego zaufanego narzędzia do tworzenia pomocy (HAT).

Koń pociągowy handlu pismami technicznymi – narzędzie pomocnicze do tworzenia, odciąża i przekształca sztukę „ułatwiania złożonych rzeczy”… no cóż, bez trudu.

HAT to maksymalizacja produktywności dla pisarzy technicznych. 10x autorzy techniczni mają mocno ugruntowaną tę stronę swojej gry.

Przy tak wielu fazach iteracyjnych rund kształtowania i edycji kopii, aby była idealnie dopasowana do celu…

…naprawdę potrzebujesz CZAPKI, która będzie działać razem z Tobą i pomoże Ci skoncentrować wszystkie wysiłki na stworzeniu najlepszego produktu literackiego.

Koncepcja kapelusza nie jest nowa.

Byli w pobliżu.

A niektórzy mogą powiedzieć, że gdyby były zdjęciami rodzinnymi, mogliby mieć nieco psie uszy, sepii, a nawet wyblaknąć.

Na przykład w wielu przypadkach posiadanie edytora WYSIWYG jest uważane za funkcję premium.

Ale myśląc bardziej z boku, czy istnieje powód do zastosowania wszechstronności i wieloaspektowych, możliwych do przeniesienia korzyści systemu zarządzania treścią (CMS) do katapultowania HAT w XXI wiek?

Kłócilibyśmy się, w przypadku WordPress CMS – wiodącej na świecie platformy do tworzenia stron internetowych i najpopularniejszego oprogramowania CMS o milę kraju…

…odpowiedź brzmi tak.

Ale nie wierz nam tylko na słowo, dlaczego nie poświęcić kilku minut na zagłębienie się w to, dlaczego WordPress CMS to kolejna najlepsza rzecz, jaka może się przytrafić pisarzom technicznym od czasu kawy espresso w plasterkach .

Oto przewodnik HeroThemes dotyczący tworzenia narzędzia do tworzenia pomocy za pomocą WordPress.

Typowe wymagania współczesnego pisarza technicznego

Pismo techniczne obejmuje dziś wiele specjalistycznych tematów.

• Rządowa polityka publiczna
• informatyka
• Inwestowanie finansowe
• Nieruchomość

…i tak dalej.

Ale wspólne są rygorystyczne wymagania bycia tłumaczem złożoności na świat techniczny, są codziennymi zadaniami.

Według Khidra Sulemana, Technical Writer, Service Design and Assurance w UK Government Digital Service – jego regularne codzienne obowiązki to:

• udział w badaniach użytkowników
• tworzenie strategii treści
• przedstawianie planów starszym interesariuszom
• projektowanie i prototypowanie podróży użytkowników
• omawianie, redagowanie i (oczywiście) pisanie treści

Dość różnorodny.

Jednak ostatnie, ale nie najmniej ważne na tej liście było (oczywiście) robienie tego, co naprawdę robią.

Ale pisanie (a zwłaszcza pisanie techniczne) jest procesem, a nie czynnością.

Sztafeta obowiązków, które łącznie prowadzą do dostarczenia dokumentacji.

Krótko mówiąc, pisanie techniczne można opisać jako proces „…przechwytywania, organizowania i utrzymywania wiedzy o szybko zmieniających się systemach oprogramowania” – Atom Bank

I jako taka, wspólną cechą dnia z życia pisarza technicznego jest obsługa repozytoriów i baz wiedzy.

Na przykład nagrywanie cytatów lub fragmentów komentarzy ekspertów. Jak również pobieranie złotych samorodków w postaci faktów lub danych w celu weryfikacji argumentów.

Krótko mówiąc, łatwość przechowywania danych, wyszukiwania i lokalizacji lub odnajdowania – oprócz pisania – są również ważnymi funkcjami pokrewnymi narzędzia do tworzenia pomocy.

Czym jest narzędzie do tworzenia pomocy w 2022 roku?

Jeśli wierzyć większości definicji Google na stronie 1 dla narzędzia do tworzenia pomocy, dokładny opis powinien zawierać:

1. Zrobienie
2. Zarządzający
3. Wydawniczy

…dokumenty.

Większość twierdzi, że lepszą tożsamością byłby „system zarządzania treścią”.

To prawda, że ​​termin ten pojawia się zwykle w artykułach pisanych przez dostawców CMS (i pod tym względem ten artykuł nie różniłby się niczym), ale jeśli przyjrzymy się użyciu dokładności – CMS jest w końcu odpowiednią etykietą dla HAT.

Dosłownie pomaga pisarzom technicznym, autorom dokumentów pomocy.

Jeśli chodzi o dokładne wskazanie, co rozumiemy przez pomoc – przypuszczam, że nie ma twardych i szybkich zasad, jak szeroko można to ująć.

To naprawdę zależałoby od:

1. Jak głęboko producenci oprogramowania znają dyscyplinę pisania technicznego;
2. Jak przekonali ich do zaspokojenia potrzeby

W większości przypadków HAT koncentruje się na prawidłowym przygotowaniu szkiców i podstaw redakcyjnych.

A na górze zaoferuj trochę szablonów, stylizacji i kodowania.

Ale pytanie brzmi…

… czy te funkcje same w sobie wystarczą, aby sprostać wygórowanym wymaganiom współczesnego pisarza technicznego?

Dlaczego po prostu nie zapytamy kilku?…

1. W tym fragmencie informacji zwrotnej respondent (autor tekstów technicznych) przedstawia porównanie tradycyjnej funkcjonalności HAT z tradycyjnym CMS (Drupal):

„Jako administrator w Drupalu możesz przeglądać listę stron, ale jednocześnie możesz edytować tylko właściwości jednej strony. Nie ma wielokrotnego zaznaczania ani przeciągania i upuszczania . Tak więc zarządzanie tematami może być bardzo pracochłonne”.

„Jeśli usuniesz stronę, wszystkie odsyłające do niej linki zostaną zerwane i nie będzie żadnych komunikatów ostrzegających.

Tworząc link na stronie , musisz znać ścieżkę i nazwę strony docelowej – nie ma żadnych przydatnych list dostępnych stron.”

„Po wyjęciu z pudełka nie ma edytora WYSIWYG . Dla większości użytkowników HAT jest to konieczność. Możesz pisać swoje treści tylko w pełnym/przefiltrowanym html.”

(Źródło: Liść Wiśni)

2. W tym komentarzu inny pisarz techniczny omówił dwie idealne funkcje, które jego zdaniem będą modne w przyszłości oprogramowania HAT:

„Wyszukiwanie oparte na faktach: gdy użytkownik klika kartę wyszukiwania i szuka elementu, może zawęzić wyniki wyszukiwania , używając podobnych aspektów, jak pokazano na poniższym obrazku”.

„Korzystanie z dowolnego ze standardowych narzędzi do tworzenia treści — Flare, RoboHelp, Author-It, Doc-to-Help — pozostawia niedorzeczny model pojedynczego autora pracującego z jednego punktu widzenia w jednej organizacji, próbującej zebrać ocean Informacja. Ponieważ ten model jest nie do utrzymania i skalowalny, HATs znikną na rzecz opartych na współpracy technologii internetowych ”.

(Źródło: Wolałbym pisać bloga)

Podane powyżej spostrzeżenia rozszerzają zakres tradycyjnego znaczenia HAT o bardziej dynamiczną i współpracującą platformę w celu zwiększenia wydajności pisania technicznego.

Czy powinieneś rozważyć użycie systemu zarządzania treścią komponentów (CCMS) do tworzenia pomocy?

Kontrola szczegółowości prezentów.

A w dziedzinie pisania tekstów technicznych zaleta większej kontroli w cyklu produkcyjnym prowadzi do wzrostu wydajności, który przekłada się na większy zwrot z inwestycji w projekt.

Właśnie tam pojawia się system zarządzania treścią komponentów.

Co to jest system zarządzania treścią komponentów (CCMS)?

Komponentowy system zarządzania treścią to system CMS, którego elementami treści nie są strony i posty, ale fragmenty, akapity i fragmenty treści.

W ten sam sposób, kiedy przychodzisz do tworzenia nowego elementu treści w CMS, zaczynasz nową stronę lub post.

Z CCMS zacząłbyś nowy komponent (część strony lub posta).

Wiele części tworzy całą stronę, więc efekt końcowy całych stron i postów jest taki sam, ale sposób ich tworzenia jest podzielony na małe kawałki.

Czemu?

Ekonomia skali.

Pewnie, że tworzenie stron opartych na wielu elementach (każdy z własnymi metadanymi, zależnościami itp.) jest prawdopodobnie bardziej pracochłonne niż na jednym, swobodnie przepływającym kawałku.

Jednak w przypadku złożonych projektów treści na dużą skalę z dużą ilością tematycznych krzyżówek i wewnętrznych odniesień do ponownego użycia i szczegółowej wymienności na poziomie komponentów…

…CCMS oferuje wielką długoterminową przewagę zespołom piszącym.

Mianowicie, szybsze i dokładniejsze wykonywanie zadań.

Polecane artykuły pomocy dotyczące narzędzia autorskiego

Wybór najlepiej dopasowanego narzędzia do tworzenia pomocy to coś więcej niż tylko porównanie „funkcji i korzyści”.

Aby uzyskać najlepszy wynik, musisz zagłębić się w użyteczność. Zrozumienie przepływów pracy i zarządzania zadaniami pomoże Ci zapoznać się z zaletami i wadami każdego rozwiązania.

Aby pomóc Ci w zalecanym przez ekspertów poradniku na ten temat, przygotowaliśmy krótką listę przydatnych artykułów związanych z HAT:

1. Dlaczego kapelusze znikną
2. 5 powodów, dla których polecam korzystanie z narzędzia do tworzenia w chmurze
3. Co daje HAT w porównaniu z Drupalem?
4. 6 powodów, dla których warto korzystać z oprogramowania HAT
5. 5 rodzajów narzędzi autorskich, których używają pisarze techniczni

Autorzy powyższych artykułów dość kompetentnie wypowiadają się na temat HAT i podają szereg wskazówek, jak podjąć właściwą decyzję.

Jakie są główne cechy kapelusza?

Tak więc stopniowo umacniamy się w naszej opinii na temat kapeluszy, ich funkcji i zalet zewnętrznych, które powinniśmy wziąć pod uwagę oprócz tradycyjnego podejścia.

Ale nadal byłoby warto, abyśmy mieli wyczerpujące odniesienia do wszystkich rzeczy, które dezorientuje HAT.

W ten sposób możemy porównać „jabłka do jabłek” przy rozważaniu wyboru inwestycji.

Oto lista najpopularniejszych, najbardziej wszechstronnych funkcji oprogramowania HAT:

• Wiele formatów wejściowych i wyjściowych : importuj i eksportuj dane przy użyciu wielu typów plików
• W pełni funkcjonalny edytor tekstu : zarówno oparty na kodzie, jak i wizualny edytor WYSIWYG
• Zbuduj tagi : przypisz tagi tematyczne, aby tematycznie powiązać artykuły
• Szablony tematyczne : uzyskaj przewagę nad każdym elementem dzięki gotowym szablonom  
• Zakreślacz składni : przydatne podkreśla problemy gramatyczne do rozwiązania  
• Scal tagi dla metainformacji o całym projekcie : wstawiaj fragmenty wielokrotnego użytku z łatwością, używając tagów scalających, oszczędzając czas i ograniczając błąd
• Niestandardowy HTML, CSS, JavaScript: zastosuj dostosowane elementy do działania i projektowania za pomocą niestandardowego kodu internetowego
• Połącz treść projektu : łączenie treści w ramach tego samego projektu w celu uzyskania mieszanego wyniku.  
• Konfigurowalny motyw sieciowy : przełączniki, slajdy i pola wyboru do doskonalenia interfejsu narzędzia, aby poprawić wrażenia użytkownika
• Repozytorium multimediów : schludny obszar do przechowywania wszystkich Twoich obrazów, plików PDF, plików audio i wideo  
• Łatwy interfejs użytkownika : prosty w użyciu ze wszystkimi odpowiednimi elementami sterującymi w łatwo dostępnej odległości i pozycjonowaniu  
• Tłumaczenie : dostawa w wielu językach!
• Spis treści : łatwe w użyciu linki do przeskoku w każdym artykule do szybkiego czytania treści  

Wśród dedykowanych HAT-ów – powyższe punkty obejmują większość tego, czego można się spodziewać pod maską.

Korzyści z budowy niestandardowej czapki

Gdybym miał podsumować główną zaletę budowania niestandardowego HAT-a, powiedziałbym:

Opanowanie własnego zestawu narzędzi.

Dopasowany zestaw narzędzi

Kiedy jako profesjonalista masz „to, czego chcesz”, „gdzie i jak chcesz”, zwrot z inwestycji w zaoszczędzony czas i lepsze wyniki jest niezmierzony.

Po prostu nie można porównać doświadczenia używania narzędzi stworzonych „w sam raz” dla osiągnięcia sukcesu z zestawem ogólnych narzędzi „make-do”.

Tak więc dostosowywanie własnego kapelusza może wymagać znacznej pracy i zamieszania z góry.

Ale na dłuższą metę scena jest przygotowana na to, abyś pobił swój osobisty rekord w każdym projekcie.

Możliwość rozbudowy

Oczekiwanie na zaplanowane ulepszenia lub bycie wciśniętym w ulepszenia premium nie musi mieć miejsca w przypadku niestandardowej czapki.

Oczywiście, sam będziesz odpowiedzialny za serwisowanie i ulepszanie narzędzia, ale wystarczy trochę czasu na majsterkowanie, aby odpowiednio przedłużyć okres przydatności swojego HAT-a.

Krótko mówiąc, w miarę jak Twój kapelusz będzie coraz lepszy, Twoje wyniki będą lepsze.

Lepsza ogólna wydajność

Zbudowany na zamówienie HAT usunie wszystkie drobne lub przeszkadzające niedogodności z Twojego technicznego przepływu pracy.

Usuwasz wszystkie wąskie gardła i odpływy czasu, zastępując je funkcjami, opcjami i konfiguracjami, dzięki którym Twój wyścig do ukończenia projektów będzie się rozwijał.

Z łatwością zdobędziesz to, co wcześniej wydawało Ci się możliwe.

Tworzenie narzędzia do tworzenia pomocy WordPress z wtyczką Heroic Knowledge Base

Więc teraz, jeśli jesteś gotowy na odważne nowe wody i zanurz się w tworzeniu własnego CZAPKA – mamy dla Ciebie rozwiązanie.

Łatwy w użyciu.

Zbudowany na platformie, z której korzysta ponad 40% wszystkich stron internetowych.

Ze wszystkimi najlepszymi funkcjami – i nie tylko.

Oto… nasz krótki przewodnik na temat tego, kto zrobić nakrycie głowy za pomocą WordPressa.

A najlepsze jest to, że nie ma w tym żadnego kodu. Ta metoda jest bardzo przyjazna dla początkujących.

Oto skład:

1. Organizowanie i kategoryzowanie stron i plików
2. Wyszukiwanie, głosowanie, opinie i analizy
3. Często zadawane pytania dotyczące replikacji komponentów
4. Helpdesk do obsługi zapytań za pośrednictwem biletów
5. Spis treści indeks strony
6. Słownik terminów biblioteka

Krótki punkt na temat „dlaczego WordPress”.

Dla większości profesjonalistów najważniejsze jest posiadanie najlepszych narzędzi do pracy (niezależnie od tego, jak się to nazywa).

Semantyka lub wyzwiska nie mają większego znaczenia, ponieważ jesteś pogrążony w dostarczaniu i potrzebujesz silnika z pewnym momentem obrotowym, aby się wykopać.

W tym miejscu WordPress idealnie nadaje się jako platforma do tworzenia niestandardowego HAT.

Po pierwsze, zaznacza wszystkie niezbędne pola w zestawie funkcji wspomnianych wcześniej w tym artykule. I robi to z łatwością, zaraz po wyjęciu z pudełka dzięki swojej podstawowej ofercie.

Funkcje takie jak WYSIWYG i kodowanie HTML, CSS i JS to standardowe funkcje oferowane przez WordPress (wiodący na świecie system zarządzania treścią).

Ale WordPress obsługuje również hosting za pół biliona dolarów, ekonomię wtyczek i motywów.

Gracze ci są odpowiedzialni za dostarczanie rozszerzeń pierwszej klasy i wspomaganie wydajności, które sprawiają, że narzędzie jest dostosowane do celu.

Podsumowując, WordPress i towarzyszące mu wtyczki tworzą wymarzony zespół oferujący nakrycie głowy dla każdego pisarza technicznego, który chce zindywidualizować własną konfigurację.

Oto przegląd naszych zalecanych kroków, aby zbudować własny rynek online za pomocą WordPress:

Strona główna katalogu z silosowanymi kategoriami: strona centralna służąca jako indeks biblioteczny ukończonych projektów i przebadanych zasobów. Zgrabna lokalizacja, w której można uzyskać dostęp do dziennika pisania technicznego.

Użyj wtyczki Heroic Knowledge Base, aby utworzyć automatycznie połączony i wyszczególniony zestaw wcześniej opublikowanych treści HAT.

Wyszukiwanie, głosowanie, opinie i analizy: biorąc pod uwagę wezwanie do współpracy ze strony naszych współpracujących autorów technicznych z wcześniejszego artykułu, zintegrowaliśmy dynamikę i zaangażowanie z funkcjami naszego rozwiązania WordPress HAT. Zapewnienie wyszukiwania, opinii i spostrzeżeń pomoże tylko w opracowaniu większych ulepszeń.

Użyj wtyczki Heroic Knowledge Base, aby umożliwić ulepszenia badań użytkowników w celu kierowania iteracyjnym planem ulepszeń produktu.

Replikacja komponentów w często zadawanych pytaniach: skonfiguruj szczegółową kontrolę komponentów dla często zadawanych pytań, dając sobie przewagę w postaci szczuplejszej produkcji do skalowania większych projektów.

Użyj wtyczki Heroic FAQs, aby wyposażyć swój HAT we wbudowane komponenty wielokrotnego użytku z prostą instalacją i kodem sero.

Heroiczna skrzynka odbiorcza do obsługi zapytań za pośrednictwem biletów: do wygodnego wypełniania zgłoszeń do obsługi użytkowników, zapewniając responsywny kanał pomocy e-mail, który znajduje się w instalacji WordPress.

Użyj wtyczki Heroic Inbox, aby zintegrować swoją biznesową skrzynkę e-mail z pulpitem administracyjnym WordPress. Daje to ujednolicone centrum komunikacyjne w HAT, oszczędzając czas, który w przeciwnym razie byłby spędzany na poruszaniu się po chaotycznym przepływie pracy.

Heroiczny spis treści: linki ułatwiające przeglądanie Twoich artykułów pomagają czytelnikom przetrawić informacje i wyodrębnić wartości. Spraw, aby Twoje elementy były jeszcze bardziej zużywalne dzięki klasycznemu ToC.

Użyj heroicznego spisu treści, aby dodać automatycznie wypełniany spis treści do każdego ze swoich artykułów.

Słowniczek heroiczny: skompiluj listę przydatnych terminów od A do Z jako skrótu dostępu do definicji słów kluczowych w projekcie, dzięki czemu będziesz sprawny podczas pisania nowego projektu.

Użyj wtyczki Heroic Glossary, aby zainstalować słownik z możliwością przeszukiwania w swojej WordPress HAT – bez potu i (ponownie) bez kodu.

Aspose.Words: błyskawicznie konwertuj posty lub strony WordPress na pliki DOC lub DOCX i odwrotnie. Wypełnij luki w przepływie pracy i zapewnij zgodność nowego systemu ze starszymi zasobami dokumentów GDocs lub Word.

Użyj wtyczki Aspose.Words, aby włączyć dwukierunkową konwersję plików między WordPress i GDocs lub Word.

Syntax Highlighter Evolved: wyróżnij kod internetowy podczas wprowadzania niestandardowych zmian, pomagając w skupieniu się na szczegółach bez rozpraszania się.

Użyj Syntax Highlighter Evolved , aby upiększyć kod podczas wprowadzania zmian w Internecie.

Wniosek

Celowo stworzone HATs w dzisiejszych czasach tak zaawansowanych CMS-ów prawdopodobnie wymyślają koło na nowo.

Właściwie nie ma wiele (jeśli w ogóle), że nawet najbardziej zaawansowany HAT może zrobić, czego nie mógłby zrobić CMS z pewną konfiguracją.

Dodatkowo, dzięki CMS, masz dodatkową funkcjonalność, która zwiększa przewagę już konkurencyjnej oferty.

Dalszy potencjał zapewniany przez CMS (wiodący na rynku WordPress z jego wtyczkami) może rozszerzyć podobne rozwiązanie HAT poza Twoje oczekiwania.

Mnóstwo miejsca, aby zadrapać własne swędzenie i kontynuować innowacje dzięki WordPress – bez konieczności kodowania.

Szybko rozwijający się ekosystem wtyczek innych firm wspiera przewagę WordPressa na rynku dzięki specjalistycznym produktom, które przesuwają granice możliwości.

Podsumowując, jesteśmy przekonani, że WordPress CMS jest idealną platformą cyfrową, jeśli szukasz przyszłościowej, niestandardowej inwestycji w HAT.

Dlaczego nie zacząć dzisiaj?