Come creare uno strumento di creazione di aiuto utilizzando WordPress

Un buon scrittore tecnico non è mai lontano dal loro strumento di creazione della guida di fiducia (HAT).

Il cavallo di battaglia del mestiere di scrittura tecnica - uno strumento di creazione di aiuto, prende lo sforzo e trasforma l'arte di "rendere semplici cose complesse"... beh, un gioco da ragazzi.

Gli HAT sono massimizzatori di produttività per gli scrittori tecnici. 10 scrittori tecnici hanno questo lato del loro gioco saldamente impostato.

Con così tante fasi di cicli iterativi di modellatura e modifica della copia per farla atterrare come si adatta perfettamente allo scopo...

...hai davvero bisogno di un HAT che lavori al tuo fianco e ti aiuti a concentrare tutti i tuoi sforzi nella formulazione del miglior prodotto letterario.

Il concetto di HAT non è nuovo.

Sono stati in giro.

E qualcuno potrebbe dire che se fossero state una foto di famiglia avrebbero potuto diventare leggermente con le orecchie da cane, color seppia e persino sbiadite di rilevanza.

Ad esempio, in molti casi, possedere un editor WYSIWYG è considerato una funzionalità premium.

Ma pensando in modo più laterale, c'è un caso per applicare la versatilità e i molteplici vantaggi trasferibili di un sistema di gestione dei contenuti (CMS) per catapultare gli HAT nel 21° secolo?

Diremmo che, nel caso di WordPress CMS, la piattaforma di creazione di siti Web leader nel mondo e il software CMS più popolare da un miglio di un paese...

…la risposta è si.

Ma non crederci sulla parola, perché non dedicare i prossimi minuti ad approfondire un po' il motivo per cui WordPress CMS è la prossima cosa migliore che accada per gli scrittori tecnici dopo il caffè espresso con pane a fette .

Eccola, la guida di HeroThemes per creare uno strumento di creazione di aiuto utilizzando WordPress.

Le richieste tipiche dello scrittore tecnico di oggi

La scrittura tecnica oggi abbraccia molte materie specialistiche.

• Politica pubblica del governo
• Informatica
• Investimenti finanziari
• Immobiliare

...l'elenco continua.

Ma comuni in tutto sono le rigorose esigenze di essere traduttori di complessità verso il mondo tecnico sono le attività quotidiane.

Secondo Khidr Suleman, scrittore tecnico, Service Design and Assurance presso il servizio digitale del governo del Regno Unito, i seguenti sono i suoi compiti quotidiani regolari:

• partecipazione alla ricerca sugli utenti
• creazione di strategie di contenuto
• presentare i piani agli stakeholder senior
• progettazione e prototipazione dei percorsi degli utenti
• discutere, modificare e (ovviamente) scrivere contenuti

Abbastanza vario.

Eppure, ultimo ma non meno importante in quella lista c'era (ovviamente) quello che fanno veramente.

Ma la scrittura (e soprattutto la scrittura tecnica) è un processo piuttosto che un'attività.

Una staffetta di compiti che portano collettivamente alla consegna della documentazione.

In poche parole, la scrittura tecnica può essere descritta come il processo di "...acquisizione, organizzazione e mantenimento della conoscenza sui sistemi software in rapida evoluzione" - Atom Bank

E come tale, una caratteristica comune di una giornata nella vita di uno scrittore tecnico è la gestione di repository e basi di conoscenza.

Ad esempio, registrare citazioni o frammenti di commenti di esperti. Oltre a recuperare pepite d'oro sotto forma di fatti o dati per convalidare gli argomenti.

In breve, la facilità di archiviazione dei dati, ricerca e localizzazione o scoperta, oltre alla scrittura, sono anche importanti funzioni alleate di uno strumento di creazione della guida.

Che cos'è uno strumento di creazione della guida nel 2022?

Se si deve credere alla maggior parte delle definizioni di Google della pagina 1 per lo strumento di creazione della guida, una descrizione accurata dovrebbe includere:

1. Fabbricazione
2. Gestire
3. Editoria

…documenti.

La maggior parte afferma che un'identità migliore sarebbe "sistema di gestione dei contenuti".

Premesso che questo termine tende ad essere incluso negli articoli scritti dai fornitori di CMS (e a questo proposito, questo articolo non sarebbe diverso), ma se esaminiamo l'uso accurato, un CMS è dopo tutto un'etichetta appropriata per un HAT.

Assiste letteralmente i documenti di aiuto dell'autore di scrittori tecnici.

Per quanto riguarda l'individuazione di ciò che intendiamo esattamente per aiuto, suppongo che non ci siano regole rigide su quanto ampiamente potresti prenderlo.

Dipenderebbe davvero da:

1. Quanto profondamente i produttori di software conoscono la disciplina della scrittura tecnica e;
2. Come erano persuasi a soddisfare il bisogno

Nella maggior parte dei casi, HAT si concentra sull'ottenere le basi redazionali e redazionali corrette.

E offri un po 'di modelli, stili e codici in cima.

Ma la domanda è...

... queste funzioni da sole sono sufficienti per soddisfare le elevate esigenze dello scrittore tecnico moderno?

Perché non ne chiediamo solo alcuni?...

1. In questo estratto di feedback, l'intervistato (uno scrittore tecnico) fornisce una revisione comparativa di una funzionalità HAT tradizionale rispetto a un CMS tradizionale (Drupal):

“Come amministratore in Drupal, puoi visualizzare un elenco di pagine, ma puoi modificare solo le proprietà di una pagina alla volta. Non c'è selezione multipla né trascinamento della selezione . Quindi la gestione degli argomenti può essere molto laboriosa".

"Se elimini una pagina, tutti i collegamenti che puntano ad essa si interromperanno e non ci saranno messaggi di avviso.

Quando crei un collegamento in una pagina devi conoscere il percorso e il nome della pagina di destinazione : non ci sono elenchi utili di pagine disponibili".

“Pronto all'uso non esiste un editor WYSIWYG . Per la maggior parte degli utenti HAT questo è un must. Puoi scrivere i tuoi contenuti solo in html completo/filtrato.

(Fonte: Foglia di ciliegio)

2. In questo commento, un altro scrittore tecnico di carriera ha discusso due funzioni ideali che secondo lui sarebbero di tendenza per il futuro del software HAT:

"Ricerca factted: quando un utente fa clic sulla scheda di ricerca e cerca un elemento, l' utente può restringere i risultati della ricerca utilizzando faccette simili, come mostrato nell'immagine seguente."

"L'utilizzo di uno qualsiasi degli strumenti di authoring standard - Flare, RoboHelp, Author-It, Doc-to-Help - ti lascia con il modello ridicolo di un singolo autore che lavora da un unico punto di osservazione da un'unica organizzazione che cerca di mettere insieme un oceano di informazione. Poiché quel modello è insostenibile e non scalabile, gli HAT svaniranno a favore delle tecnologie di authoring collaborativo basate sul Web ".

(Fonte: preferirei scrivere un blog)

Le informazioni fornite sopra espandono il mandato del tradizionale senso di un HAT per includere una piattaforma più dinamica e collaborativa per migliorare la produttività della scrittura tecnica.

Dovresti considerare l'utilizzo di un Component Content Management System (CCMS) per la creazione della guida?

Controllo dei regali di granularità.

E nel campo della scrittura tecnica, il vantaggio di un maggiore controllo all'interno del ciclo produttivo genera efficienze che si traducono in un ROI più ampio del progetto.

È proprio qui che entra in gioco un sistema di gestione dei contenuti dei componenti.

Che cos'è un sistema di gestione dei contenuti dei componenti (CCMS)?

Un sistema di gestione dei contenuti componente è un CMS i cui elementi di contenuto non sono pagine e post, ma piuttosto frammenti, paragrafi e porzioni di contenuto.

Allo stesso modo, quando arrivi a produrre un nuovo contenuto in un CMS, inizieresti una nuova pagina o un nuovo post.

Con un CCMS, inizieresti un nuovo componente (porzione di una pagina o post).

Molte porzioni formano un'intera pagina, quindi il risultato finale di intere pagine e post è lo stesso, ma il modo in cui sono realizzati è suddiviso in piccoli pezzi.

Come mai?

Economie di scala.

Sicuramente è probabilmente più lavoro costruire pagine basate su più pezzi (ognuno con i propri metadati, dipendenze ecc.) piuttosto che un intero pezzo a flusso libero.

Ma, con progetti di contenuti complessi su larga scala con molti incroci di attualità e riferimenti interni, la riusabilità e l'intercambiabilità granulare a livello di componenti...

…un CCMS offre un grande vantaggio a lungo termine ai team di scrittura.

Vale a dire, fare le cose in modo più rapido e accurato.

Articoli consigliati per lo strumento di creazione della guida

La scelta dello strumento di creazione della guida più adatto è più di un semplice confronto di "caratteristiche e vantaggi".

Per ottenere il miglior risultato, devi approfondire l'usabilità. Comprendere i flussi di lavoro e la gestione delle attività ti aiuterà a vedere i pro ei contro presentati da ciascuna soluzione.

Per assisterti in alcuni consigli consigliati dai pari sull'argomento, abbiamo raccolto questo rapido elenco di utili articoli relativi a HAT:

1. Perché i cappelli svaniranno
2. 5 motivi per cui consiglio di utilizzare uno strumento di creazione basato su cloud
3. Cosa ti dà un HAT rispetto a Drupal?
4. 6 motivi per utilizzare il software HAT
5. 5 tipi di strumenti di creazione utilizzati dagli scrittori tecnici

Gli autori degli articoli sopra parlano in modo abbastanza ben informato sull'argomento HAT e danno una serie di suggerimenti interni per prendere la decisione giusta.

Quali sono le caratteristiche principali di un HAT?

Quindi, stiamo gradualmente rafforzando il nostro punto di vista sugli HAT, su cosa fanno e sui vantaggi esterni che dovremmo considerare oltre all'approccio tradizionale.

Ma varrebbe comunque la pena avere un riferimento completo per tutte le cose che un HAT deos.

In questo modo possiamo confrontare "mele per mele" quando si considera una scelta di investimento.

Ecco un elenco delle funzioni software HAT più comuni e inclusive:

• Più formati di input e output : importa ed esporta dati utilizzando molti tipi di file
• Elaboratore di testi completo : editor WYSIWYG sia basato su codice che visivo
• Costruisci tag : assegna tag di attualità per correlare gli articoli tematicamente
• Modelli di argomenti : ottieni un vantaggio su ogni pezzo con modelli predefiniti  
• Evidenziatore di sintassi : punti salienti utili su problemi grammaticali da risolvere  
• Unisci i tag per le meta-informazioni a livello di progetto : inserisci facilmente frammenti riutilizzabili utilizzando i tag di unione, risparmiando tempo e limitando gli errori
• HTML personalizzato, CSS, Javascript: applica tocchi su misura per funzionare e progettare con codice web personalizzato
• Unisci il contenuto del progetto : combina il contenuto all'interno dello stesso progetto per produrre un risultato misto.  
• Tema web personalizzabile : interruttori, diapositive e checkbox per perfezionare il frontend dello strumento per migliorare la tua esperienza utente
• Archivio multimediale : un'area di archiviazione ordinata per tutte le tue immagini, PDF, file audio e video  
• Interfaccia utente facile : semplice da usare con tutti i relativi comandi a distanza e posizionamento facili da raggiungere  
• Traduzione : consegna in più lingue
• Sommario : link di facile utilizzo in ogni articolo per leggere il contenuto  

Tra gli HAT dedicati là fuori, i punti sopra coprono la maggior parte di ciò che ci si aspetterebbe sotto il cofano.

Vantaggi della creazione di un HAT personalizzato

Se dovessi riassumere il vantaggio principale della creazione di un HAT personalizzato, direi:

Padronanza del tuo set di strumenti.

Set di strumenti su misura

Quando hai 'quello che vuoi', 'dove e come lo vuoi' come professionista, il ritorno sull'investimento in tempo risparmiato e risultati migliori è incommensurabile.

Semplicemente non è possibile confrontare l'esperienza dell'utilizzo di strumenti realizzati "giusti" per il successo rispetto a un insieme di strumenti generici "per fare in modo".

Quindi la personalizzazione del tuo HAT potrebbe comportare un notevole lavoro iniziale e confusione.

Ma a lungo termine la scena è pronta per te battere il tuo record personale con ogni progetto.

Espandibile

L'attesa di miglioramenti della roadmap o l'essere schiacciati in aggiornamenti premium non devono necessariamente accadere con un HAT personalizzato.

Certo, sarai tu stesso responsabile della manutenzione e del miglioramento dello strumento, ma solo per un po' di tempo fai-da-te puoi prolungare opportunamente la durata di conservazione del tuo HAT.

In breve, man mano che il tuo HAT migliora, anche i tuoi risultati miglioreranno.

Migliori prestazioni a tutto tondo

Un HAT personalizzato rimuoverà tutti i fastidi meschini o ostruttivi dal tuo flusso di lavoro di scrittura tecnica.

Rimuovi tutti i colli di bottiglia e le perdite di tempo, sostituendoli con funzionalità, opzioni e configurazioni che danno alla tua corsa al completamento dei progetti un vento favorevole.

Potrai facilmente estrarre ciò che pensavi fosse possibile in precedenza.

Creazione di uno strumento di creazione della guida di WordPress con il plug-in Heroic Knowledge Base

Quindi, a questo punto, se sei pronto per affrontare nuove acque e fare il grande passo per creare il tuo CAPPELLO, abbiamo la soluzione per te.

Facile da usare.

Costruito su una piattaforma utilizzata da oltre il 40% di tutti i siti web online.

Con tutte le migliori caratteristiche e molto altro ancora.

Eccola qui... la nostra guida rapida su chi realizzare un HAT utilizzando WordPress.

E la parte migliore è che non c'è alcun codice coinvolto. Questo metodo è molto adatto ai principianti.

Ecco la scaletta:

1. Organizzazione e categorizzazione di pagine e file
2. Ricerca, votazione, feedback e analisi
3. Replica dei componenti delle domande frequenti
4. Helpdesk per la gestione delle richieste tramite ticket
5. Indice della pagina Sommario
6. Libreria dei termini del glossario

Un rapido punto sul "perché WordPress".

Per la maggior parte dei professionisti, disporre degli strumenti migliori per il lavoro (indipendentemente da come si chiami) è la cosa più importante.

La semantica o il soprannome non contano molto poiché diventi immerso nei risultati finali e hai bisogno di un motore con una certa coppia per tirarti fuori.

È qui che WordPress è l'ideale come piattaforma per creare un HAT personalizzato.

Innanzitutto, spunta tutte le caselle essenziali nell'allineamento delle funzioni menzionato in precedenza in questo articolo. E lo fa con facilità, subito pronto all'uso con la sua offerta principale.

Funzionalità come WYSIWYG e codifica HTML, CSS e JS sono funzionalità standard offerte da WordPress (il sistema di gestione dei contenuti leader nel mondo).

Ma WordPress ospita anche mezzo trilione di dollari di hosting, plugin e temi economici.

Questi giocatori sono responsabili della fornitura delle estensioni di 1a classe e dell'assistenza alle prestazioni che rendono lo strumento adatto allo scopo.

Tutto sommato, WordPress e i suoi compagni di plug-in creano un dream team che offre un HAT per qualsiasi scrittore tecnico che desideri creare il proprio set-up fai-da-te.

Ecco una panoramica dei nostri passaggi consigliati per creare il tuo mercato online utilizzando WordPress:

Home page della directory con categorie in silos: una pagina hub che funge da indice della libreria di riferimento dei progetti completati e delle risorse ricercate. Una posizione ordinata per accedere al registro di scrittura tecnica.

Usa il plug-in Heroic Knowledge Base per produrre una line-up collegata e dettagliata automaticamente dei tuoi contenuti HAT pubblicati in precedenza.

Ricerca, votazione, feedback e analisi: prendendo atto della richiesta di collaborazione dei nostri autori tecnici che contribuiscono in precedenza all'interno dell'articolo, abbiamo integrato dinamismo e coinvolgimento nelle funzionalità della nostra soluzione HAT di WordPress. Fornire ricerca, feedback e approfondimenti aiuterà solo a sviluppare miglioramenti maggiori.

Utilizza il plug-in Heroic Knowledge Base per abilitare i miglioramenti della ricerca degli utenti per indirizzare una roadmap di miglioramento iterativa per il prodotto.

Replica dei componenti delle domande frequenti : configura il controllo granulare dei componenti sulle domande frequenti, offrendoti il ​​vantaggio di avere una produzione più snella per la scalabilità di progetti più grandi.

Usa il plug-in Heroic FAQs per equipaggiare il tuo HAT con componenti riutilizzabili integrati con una semplice installazione e sero-code.

Posta in arrivo eroica per la gestione delle richieste tramite ticket: per mettere comodamente in campo i ticket di assistenza per gli utenti offrendoti un canale di assistenza e-mail reattivo che si trova all'interno della tua installazione di WordPress.

Usa il plug-in Heroic Inbox per integrare la tua casella di posta elettronica aziendale nella dashboard di amministrazione di WordPress. Ciò ti offre un hub di comunicazione unificato all'interno del tuo HAT risparmiando tempo perso altrimenti speso a navigare in un flusso di lavoro disgiunto.

Sommario eroico: i collegamenti rapidi per facilitare la lettura scremata dei tuoi articoli aiutano i lettori a digerire informazioni ed estrarre valore. Rendi i tuoi pezzi ancora più consumabili con un ToC classico.

Usa il sommario eroico per aggiungere un sommario a compilazione automatica a ciascuno dei tuoi articoli.

Glossario eroico: compila un elenco dalla A alla Z di termini utili come scorciatoia per accedere alle definizioni delle parole chiave su un progetto, mantenendoti agile mentre scrivi il tuo nuovo progetto.

Usa il plug-in Heroic Glossary per installare un glossario ricercabile nel tuo WordPress HAT: niente sudore e (di nuovo) nessun codice.

Aspose.Words: converti istantaneamente i post o le pagine di WordPress in file DOC o DOCX e viceversa. Colma le lacune del flusso di lavoro e rendi il tuo nuovo sistema compatibile con GDocs legacy o risorse di documenti Word.

Usa il plug-in Aspose.Words per abilitare la conversione di file bidirezionale tra WordPress e GDocs o Word.

Syntax Highlighter Evolved: fai risaltare il codice web mentre apporti modifiche personalizzate, aiutandoti a concentrarti sui dettagli senza distrazioni.

Usa Syntax Highlighter Evolved per rendere il codice bello mentre apporti le tue modifiche web savvy.

Conclusione

Gli HAT appositamente realizzati in questi giorni di CMS così avanzati stanno probabilmente reinventando la ruota.

In realtà non c'è molto (se non altro) che anche l'HAT più avanzato può fare che un CMS con alcune configurazioni non potrebbe fare.

Inoltre, con un CMS, hai funzionalità aggiuntive che aggiungono vantaggio a un'offerta già competitiva.

L'ulteriore potenziale fornito da un CMS (il WordPress leader di mercato con i suoi plug-in) può estendere una soluzione HAT simile oltre le tue aspettative.

Tanto spazio per grattarti i pruriti e continuare a innovare con WordPress, inoltre non è necessaria alcuna codifica.

Un ecosistema di plug-in di terze parti in rapida espansione supporta il vantaggio della quota di mercato di WordPress con prodotti specializzati per spingere i confini delle possibilità.

Tutto sommato, siamo convinti che se stai cercando di fare un investimento HAT personalizzato a prova di futuro, WordPress CMS è la piattaforma digitale ideale.

Perché non iniziare oggi?