Cum să construiți un instrument de creație de ajutor folosind WordPress

Un bun scriitor tehnic nu este niciodată departe de instrumentul lor de încredere (HAT).

Calul de bătaie al comerțului de scris tehnic – un instrument de ajutor pentru creație, preia efortul și transformă arta de a „face lucrurile complexe clare”... ei bine, o simplă simplitate.

HAT-urile sunt maximizatoare de productivitate pentru scriitorii tehnici. Scriitorii tehnici de 10 ori au această latură a jocului lor bine stabilită.

Cu atât de multe faze de runde iterative de modelare și editare a copiei pentru ca acesta să se potrivească perfect scopului...

…ai nevoie într-adevăr de un HAT care să lucreze alături de tine și să te ajute să-ți concentrezi toate eforturile în formularea celui mai bun produs literar.

Conceptul de HAT nu este nou.

Au fost prin preajmă.

Și unii ar putea spune, dacă ar fi fost o fotografie de familie, ar fi putut deveni ușor urechi de câine, sepia și chiar și-ar fi decolorat în relevanță.

De exemplu, în multe cazuri, deținerea unui editor WYSIWYG este considerată o caracteristică premium.

Dar gândind mai lateral, există un caz pentru aplicarea versatilității și a beneficiilor transferabile cu mai multe fațete ale unui sistem de management al conținutului (CMS) pentru a catapulta HAT-urile în secolul 21?

Am argumenta că, în cazul WordPress CMS – cea mai importantă platformă de construcție web din lume și cel mai popular software CMS la o milă de țară...

…raspunsul este da.

Dar nu ne credeți pe cuvânt, de ce să nu luați următoarele câteva minute pentru a aprofunda puțin de ce WordPress CMS este cel mai bun lucru care se întâmplă pentru scriitorii tehnici de la felii de cafea espresso.

Iată, ghidul HeroThemes pentru construirea unui instrument de creație de ajutor folosind WordPress.

Cerințele tipice ale scriitorului tehnic de astăzi

Scrierea tehnică de astăzi acoperă multe subiecte de specialitate.

• Politica publică guvernamentală
• informatică IT
• Investiții financiare
• Proprietate imobiliara

... lista poate continua.

Dar comune sunt cerințele riguroase de a fi traducători de complexitate pentru lumea tehnică sunt sarcinile de zi cu zi.

Potrivit lui Khidr Suleman, scriitor tehnic, design de servicii și asigurare la Serviciul digital guvernamental al Regatului Unit – următoarele sunt sarcinile sale zilnice obișnuite:

• participarea la cercetarea utilizatorilor
• crearea de strategii de conținut
• prezentarea planurilor părților interesate seniori
• proiectarea și prototiparea călătoriilor utilizatorilor
• discutarea, editarea și (desigur) scrierea conținutului

Destul de divers.

Cu toate acestea, nu în ultimul rând pe acea listă era (desigur) să facă ceea ce fac ei cu adevărat.

Dar scrisul (și mai ales scrisul tehnic) este mai degrabă un proces decât o activitate.

O cursă de ștafetă a sarcinilor care duc în mod colectiv la livrarea documentației.

Pe scurt, scrierea tehnică poate fi descrisă ca fiind procesul de „...captarea, organizarea și menținerea cunoștințelor despre sistemele software care se schimbă rapid” – Atom Bank

Și, ca atare, o caracteristică comună a unei zile din viața unui scriitor tehnic este gestionarea depozitelor și a bazelor de cunoștințe.

Înregistrarea de citări sau fragmente de comentarii ale experților, de exemplu. De asemenea, recuperarea pepitelor de aur sub formă de fapte sau date pentru a valida argumentele.

Pe scurt, ușurința în stocarea datelor, căutarea și localizarea sau descoperirea – în afară de scriere – sunt, de asemenea, funcții aliate importante ale unui instrument de creație de ajutor.

Ce este un instrument de creare a ajutorului în 2022?

Dacă se crede că majoritatea definițiilor Google de la pagina 1 pentru instrumentul de creație de ajutor, o descriere exactă ar trebui să includă:

1. Făcând
2. Gestionarea
3. Publicare

…documente.

Majoritatea susțin că o identitate mai bună ar fi „sistemul de management al conținutului”.

Desigur, acest termen tinde să fie inclus în articolele scrise de furnizorii de CMS (și în acest sens, acest articol nu ar fi diferit), dar dacă examinăm utilizarea acurateței – un CMS este, până la urmă, o etichetă adecvată pentru un HAT.

Ajută literalmente scriitorii tehnici pentru documente de ajutor.

În ceea ce privește indicarea exactă a ceea ce înțelegem prin ajutor, presupun că nu există reguli stricte și rapide cu privire la cât de larg ați putea înțelege asta.

Chiar ar depinde de:

1. Cât de profund cunosc producătorii de software disciplina tehnică de scriere și;
2. Cât de convinși erau să îndeplinească nevoia

În cele mai multe cazuri, HAT se concentrează pe obținerea corectă a elementelor de bază pentru redactare și editoriale.

Și oferă puțin, modelare, stil și codare pe deasupra.

Dar întrebarea este…

…sunt aceste funcții suficiente singure pentru a satisface cerințele abrupte ale scriitorului tehnic modern?

De ce nu întrebăm doar câteva?...

1. În acest fragment de feedback, respondentul (un scriitor tehnic) oferă o revizuire comparativă a funcționalității tradiționale HAT față de un CMS tradițional (Drupal):

„Ca administrator în Drupal, puteți vizualiza o listă de pagini, dar puteți edita doar proprietățile unei pagini odată. Nu există selecție multiplă și nu există glisare și plasare . Deci managementul subiectelor poate fi foarte laborios.”

„Dacă ștergeți o pagină, toate linkurile care indică către ea se vor rupe și nu există mesaje care să vă avertizeze.

Când creați un link într-o pagină , trebuie să cunoașteți calea și numele paginii de destinație - nu există liste utile de pagini disponibile.”

„Nu există nici un editor WYSIWYG . Pentru majoritatea utilizatorilor HAT, acest lucru este o necesitate. Puteți scrie conținutul dvs. numai în format html complet/filtrat.”

(Sursa: Frunza de cireș)

2. În acest comentariu, un alt scriitor tehnic de carieră a discutat două funcții ideale despre care crede că ar fi în tendințe pentru viitorul software-ului HAT:

„Căutare realizată: când un utilizator face clic pe fila de căutare și caută un articol, utilizatorul poate restrânge rezultatele căutării utilizând fațete similare, așa cum se arată în imaginea următoare.”

„Folosirea oricăruia dintre instrumentele standard de creație – Flare, RoboHelp, Author-It, Doc-to-Help – vă lasă cu modelul ridicol al unui singur autor care lucrează dintr-un singur punct de vedere dintr-o singură organizație care încearcă să reunească un ocean de informație. Deoarece acest model este insustenabil și nescalabil, HAT-urile se vor estompa în favoarea tehnologiilor de creație colaborative bazate pe web .”

(Sursa: Aș prefera să scriu pe blog)

Perspectivele prezentate mai sus extind misiunea sensului tradițional al unui HAT pentru a include o platformă mai dinamică și mai colaborativă pentru îmbunătățirea productivității scrisului tehnic.

Ar trebui să luați în considerare utilizarea unui sistem de management al conținutului cu componente (CCMS) pentru crearea ajutorului?

Controlul granularității cadourilor.

Iar în domeniul scrierii tehnice, avantajul unui control mai mare în cadrul ciclului de producție generează eficiențe care se traduc într-un ROI mai mare al proiectului.

Aici intervine exact un sistem de management al conținutului componentelor.

Ce este un sistem de management al conținutului componentelor (CCMS)?

Un sistem de management al conținutului component este un CMS ale cărui elemente de conținut nu sunt pagini și postări, ci mai degrabă fragmente, paragrafe și porțiuni de conținut.

În același mod, atunci când veniți să produceți o nouă bucată de conținut într-un CMS, ați începe o pagină sau o postare nouă.

Cu un CCMS, ați începe o nouă componentă (porțiune dintr-o pagină sau postare).

Multe porțiuni formează o pagină întreagă, astfel încât rezultatul final al paginilor întregi și al postărilor este același, dar modul în care sunt făcute este împărțit în bucăți mici.

De ce?

Economie de scară.

Sigur că este, probabil, mai multă muncă să construiești pagini bazate pe mai multe piese (fiecare cu propriile metadate, dependențe etc.) decât pe o singură bucată întreagă care curge liber.

Dar, cu proiecte de conținut complex la scară largă, cu o mulțime de încrucișări topice și referințe interne, reutilizarea și interschimbabilitatea granulară la nivel de componentă...

…un CCMS oferă un avantaj mare pe termen lung echipelor de redactare.

Și anume, să faci lucrurile mai rapid și mai precis.

Ajutor recomandat Instrumentul de creație Articole de sfaturi

Alegerea celui mai potrivit instrument de creație de ajutor este mai mult decât o simplă comparație a „funcțiilor și beneficiilor”.

Pentru a obține cel mai bun rezultat, trebuie să vă adânciți în utilizare. Înțelegerea fluxurilor de lucru și a gestionării sarcinilor vă va ajuta să vedeți avantajele și dezavantajele prezentate de fiecare soluție.

Pentru a vă ajuta cu recomandările de la colegi pe această temă, am adunat această listă rapidă de articole utile legate de HAT:

1. De ce pălăriile se vor estompa
2. 5 motive pentru care recomand să folosiți un instrument de creație bazat pe cloud
3. Ce vă oferă un HAT față de Drupal?
4. 6 motive pentru a folosi software-ul HAT
5. 5 tipuri de instrumente de creație pe care le folosesc scriitorii tehnici

Autorii articolelor de mai sus vorbesc destul de informat despre subiectul HAT și oferă o serie de sfaturi interne pentru a lua decizia corectă.

Care sunt principalele caracteristici ale unui HAT?

Așadar, ne consolidăm treptat viziunea asupra HAT-urilor, a ceea ce fac acestea și a avantajelor externe pe care ar trebui să le luăm în considerare în afară de abordarea tradițională.

Dar tot ar merita să avem o referință cuprinzătoare pentru toate lucrurile pe care un HAT deos.

Astfel putem compara „mere pentru mere” atunci când luăm în considerare o alegere de investiție.

Iată o listă cu cele mai comune și mai cuprinzătoare funcții software HAT:

• Formate multiple de intrare și ieșire : importați și exportați date folosind mai multe tipuri de fișiere
• Procesor de text complet : editor WYSIWYG atât bazat pe cod, cât și vizual
• Creați etichete : atribuiți etichete de actualitate pentru a lega articolele tematic
• Șabloane de subiecte : obțineți un avans pentru fiecare piesă cu șabloane prefabricate  
• Evidențiator de sintaxă: evidențieri utile asupra problemelor gramaticale de rezolvat  
• Îmbinați etichete pentru metainformații la nivel de proiect : inserați fragmente reutilizabile cu ușurință folosind etichete de îmbinare, economisind timp și limitarea erorilor
• HTML personalizat, CSS, Javascript: aplicați atingeri personalizate funcțiilor și designului cu cod web personalizat
• Îmbină conținutul proiectului : combinarea conținutului în cadrul aceluiași proiect pentru a produce un rezultat combinat.  
• Temă web personalizabilă : comutatoare, diapozitive și casete de selectare pentru perfecționarea front-end-ului instrumentului pentru a vă îmbunătăți experiența utilizatorului
• Depozitare media : o zonă de stocare îngrijită pentru toate imaginile, PDF-urile, fișierele audio și video  
• Interfață de utilizator ușoară : simplu de utilizat, cu toate comenzile relevante, la distanță și poziționare ușor de atins  
• Traducere : livrare în mai multe limbi
• Cuprins : link-uri de salt ușor de utilizat în fiecare articol pentru citirea rapidă a conținutului  

Printre HAT-urile dedicate de acolo – punctele de mai sus acoperă cea mai mare parte a ceea ce ar fi de așteptat sub capotă.

Beneficiile construirii unui HAT personalizat

Dacă ar fi să rezum avantajul principal al construirii unui HAT personalizat, aș spune:

Stăpânirea propriului set de instrumente.

Set de instrumente personalizat

Când ai „ce vrei”, „unde și cum vrei” ca profesionist, rentabilitatea investiției în timp economisit și rezultate îmbunătățite este incomensurabilă.

Pur și simplu nu poți compara experiența utilizării unor instrumente „doar potrivite” pentru succes cu un set de instrumente generice „de-a face”.

Așadar, personalizarea propriei dvs. HAT ar putea implica muncă și agitație în avans considerabile.

Dar, pe termen lung, scena este pregătită pentru a vă bate cel mai bun personal cu fiecare proiect.

Extensibil

Nu este necesar să așteptați îmbunătățiri planificate sau să fiți forțat de upgrade-uri premium cu un HAT personalizat.

Sigur, veți fi responsabil pentru întreținerea și îmbunătățirea unealtei dvs., dar doar pentru puțin timp de bricolaj puteți prelungi în mod adecvat durata de valabilitate a PĂLĂRIEI dumneavoastră.

Pe scurt, pe măsură ce HAT-ul tău se îmbunătățește, la fel și rezultatele tale.

Performanță generală mai bună

O HAT personalizată va elimina toate supărările mărunte sau obstructive din fluxul dvs. de lucru de scriere tehnică.

Îndepărtați toate blocajele și scurgerile de timp, înlocuindu-le cu caracteristici, opțiuni și configurații care oferă cursei voastre spre finalizarea proiectelor un vânt următor.

Veți obține cu ușurință ceea ce credeați că este posibil anterior.

Crearea unui instrument de creare a ajutorului WordPress cu pluginul Heroic Knowledge Base

Deci, până acum, dacă ești gata să înfrunți ape noi și să faci pasul în a-ți crea propria PĂLĂRIE, avem soluția pentru tine.

Ușor de folosit.

Construit pe o platformă utilizată de peste 40% din toate site-urile online.

Cu toate cele mai bune caracteristici – plus multe altele.

Iată-l... ghidul nostru rapid despre cine să facă un HAT folosind WordPress.

Și cea mai bună parte este că nu există niciun cod implicat. Această metodă este foarte prietenoasă pentru începători.

Iată lista:

1. Organizarea și clasificarea paginilor și fișierelor
2. Căutare, vot, feedback și analiză
3. Întrebări frecvente replicarea componentelor
4. Serviciu de asistență pentru gestionarea întrebărilor prin intermediul biletelor
5. Indexul paginii Cuprins
6. Biblioteca de termeni glosar

Un punct rapid despre „de ce WordPress”.

Pentru majoritatea profesioniștilor, a avea cele mai bune instrumente pentru job (indiferent de cum se numește) este cel mai important lucru.

Semantica sau chemarea numelui nu contează prea mult, deoarece devii cufundat în livrabile și ai nevoie de un motor cu un anumit cuplu care să te scoată.

Aici WordPress este ideal ca platformă pentru realizarea unui HAT personalizat.

În primul rând, bifează toate căsuțele esențiale din gama de funcții menționată mai devreme în acest articol. Și face asta cu ușurință, direct din cutie, cu oferta sa de bază.

Caracteristici precum codarea WYSIWYG și HTML, CSS și JS sunt caracteristici standard oferite de WordPress (cel mai important sistem de management al conținutului din lume).

Dar WordPress găzduiește și o jumătate de trilion de dolari pentru găzduire, plugin și economie tematică.

Acești jucători sunt responsabili pentru furnizarea de extensii de primă clasă și de asistență pentru performanță, care fac din instrument un scop personalizat.

Una peste alta, WordPress și însoțitorii săi de plugin reprezintă o echipă de vis care oferă o PĂLĂRIER pentru orice scriitor tehnic care dorește să-și facă propriul set-up.

Iată o prezentare generală a pașilor noștri recomandați pentru construirea propriei piețe online folosind WordPress:

Pagina principală a directorului cu categorii separate: o pagină centrală care servește ca index al bibliotecii de referință pentru proiectele finalizate și resursele cercetate. O locație perfectă pentru a vă accesa jurnalul de scriere tehnică.

Utilizați pluginul Heroic Knowledge Base pentru a produce o linie automată legată și detaliată a conținutului dvs. HAT publicat anterior.

Căutare, vot, feedback și analiză: luând notă de apelul de colaborare din partea autorilor noștri tehnici care contribuie mai devreme în articol, am integrat dinamism și implicare în funcțiile soluției noastre WordPress HAT. Furnizarea de căutări, feedback și perspective va ajuta doar la dezvoltarea unor îmbunătățiri mai mari.

Utilizați pluginul Heroic Knowledge Base pentru a activa îmbunătățirea cercetării utilizatorilor pentru a direcționa o foaie de parcurs iterativă de îmbunătățire a produsului.

Întrebări frecvente replicare componente : configurați controlul granular al componentelor la întrebările frecvente, oferindu-vă avantajul de a avea o producție mai simplă pentru scalarea proiectelor mai mari.

Utilizați pluginul Heroic FAQs pentru a vă pregăti HAT cu componente reutilizabile încorporate cu instalare simplă și cod sero.

Inbox eroic pentru gestionarea solicitărilor prin bilete: pentru a trimite comod biletele de asistență pentru utilizatori, oferindu-vă un canal de ajutor de e-mail receptiv, care se află în interiorul instalării WordPress.

Utilizați pluginul Heroic Inbox pentru a integra căsuța de e-mail de afaceri în tabloul de bord administrativ WordPress. Acest lucru vă oferă un hub de comunicații unificate în cadrul dvs. HAT, economisind timpul pierdut petrecut în alt mod navigând într-un flux de lucru dezarticulat.

Cuprins eroic: link-urile pentru a facilita citirea rapidă a articolelor dvs. ajută cititorii să digere informații și să extragă valoare. Faceți piesele și mai consumabile cu un ToC clasic.

Utilizați Cuprinsul Eroic pentru a adăuga un cuprins cu completare automată la fiecare dintre articolele dvs.

Glosar eroic: alcătuiește o listă AZ de termeni utili ca scurtătură pentru a accesa definițiile cuvintelor cheie dintr-un proiect, menținându-te agil în timp ce scrii noul tău proiect.

Utilizați pluginul Heroic Glossary pentru a instala un glosar care poate fi căutat în WordPress HAT - fără transpirație și (din nou) fără cod.

Aspose.Words: convertiți instantaneu postările sau paginile WordPress în fișiere DOC sau DOCX și invers. Reduceți lacunele fluxului de lucru și faceți-vă noul sistem compatibil cu elementele vechi GDocs sau Word docs.

Utilizați pluginul Aspose.Words pentru a activa conversia bidirecțională a fișierelor între WordPress și GDocs sau Word.

Syntax Highlighter Evolved: scoateți în evidență codul web pe măsură ce faceți editări personalizate, ajutându-vă să vă concentrați asupra detaliilor fără distragere.

Folosiți Syntax Highlighter Evolved pentru a face codul frumos pe măsură ce faceți editări inteligente pe web.

Concluzie

Pălăriile create cu scop în aceste zile ale unor astfel de CMS-uri avansate reinventează probabil roata.

De fapt, nu există multe (dacă ceva) pe care chiar și cel mai avansat HAT cu caracteristici să poată face ceea ce un CMS cu anumite configurații nu le-ar putea face.

În plus, cu un CMS, aveți o funcționalitate suplimentară care adaugă un avantaj unei oferte deja competitive.

Potențialul suplimentar oferit de un CMS (WordPress lider de piață cu pluginurile sale) poate extinde o soluție HAT asemănătoare dincolo de așteptările dumneavoastră.

O mulțime de spațiu pentru a vă zgâria propriile mâncărimi și a continua să inovați cu WordPress - plus nu este necesară codarea.

Un ecosistem de plugin-uri terță parte care se extinde rapid susține avantajul de cotă de piață al WordPress cu produse specializate pentru a depăși limitele posibilităților.

Una peste alta, suntem convinși că dacă doriți să faceți o investiție personalizată în HAT pentru viitor, CMS WordPress este platforma digitală ideală.

De ce să nu încep azi?