Como construir uma ferramenta de autoria de ajuda usando o WordPress

Um bom escritor técnico nunca está longe de sua ferramenta de autoria de ajuda confiável (HAT).

O cavalo de batalha do comércio de redação técnica – uma ferramenta de ajuda à autoria, tira a tensão e transforma a arte de 'tornar as coisas complexas simples'... bem, uma coisa fácil.

HATs são maximizadores de produtividade para escritores técnicos. 10x escritores técnicos têm esse lado de seu jogo firmemente definido.

Com tantas fases de rodadas iterativas de modelagem e edição de cópia para tê-la como um ajuste perfeito para o propósito…

…você realmente precisa de um HAT que trabalhe ao seu lado e o ajude a concentrar todos os seus esforços na formulação do melhor produto literário.

O conceito de HAT não é novo.

Eles estiveram por aí.

E alguns podem dizer que, se fossem uma foto de família, poderiam ter ficado levemente dobradas, sépias e até desbotadas em relevância.

Por exemplo, em muitos casos, possuir um editor WYSIWYG é considerado um recurso premium.

Mas pensando mais lateralmente, existe um caso para aplicar a versatilidade e os benefícios transferíveis multifacetados de um sistema de gerenciamento de conteúdo (CMS) para catapultar HATs para o século 21?

Argumentamos que, no caso do WordPress CMS – a plataforma líder mundial de construção da web e o software CMS mais popular por um quilômetro de país…

…a resposta é sim.

Mas não acredite apenas em nossa palavra, por que não levar os próximos minutos para se aprofundar um pouco mais no motivo pelo qual o WordPress CMS é a próxima melhor coisa a acontecer para escritores técnicos desde o café expresso de pão fatiado .

Aqui está, o guia HeroThemes para construir uma ferramenta de autoria de ajuda usando o WordPress.

As demandas típicas do escritor técnico de hoje

A redação técnica hoje abrange muitos assuntos especializados.

• Políticas públicas governamentais
• computação de TI
• Investimento financeiro
• Imobiliária

…A lista continua.

Mas comuns são as exigências rigorosas de ser tradutores de complexidade para o mundo técnico são as tarefas do dia-a-dia.

De acordo com Khidr Suleman, redator técnico, design de serviço e garantia no Serviço Digital do Governo do Reino Unido - as seguintes são suas tarefas diárias regulares:

• participando de pesquisas de usuários
• criando estratégias de conteúdo
• apresentação de planos para as partes interessadas seniores
• projetar e prototipar jornadas do usuário
• discutindo, editando e (claro) escrevendo conteúdo

Bastante diversificado.

No entanto, por último, mas não menos importante, nessa lista estava (é claro) fazendo o que eles realmente fazem.

Mas a escrita (e especialmente a escrita técnica) é um processo e não uma atividade.

Uma corrida de revezamento de deveres que coletivamente levam à entrega de documentação.

Em poucas palavras, a redação técnica pode ser descrita como sendo o processo de “…captura, organização e manutenção de conhecimento sobre sistemas de software em rápida mudança” – Atom Bank

E, como tal, uma característica comum de um dia na vida de um redator técnico é lidar com repositórios e bases de conhecimento.

Gravação de citações ou trechos de comentários de especialistas, por exemplo. Assim como, recuperar pepitas de ouro na forma de fato ou dados para validar argumentos.

Em suma, a facilidade de armazenamento de dados, pesquisa e localização ou descoberta – além da escrita – também são importantes funções aliadas de uma ferramenta de autoria de ajuda.

O que é uma ferramenta de criação de ajuda em 2022?

Se acreditarmos na maioria das definições da página 1 do Google para a ferramenta de criação de ajuda, uma descrição precisa deve incluir:

1. Fazer
2. Gerenciando
3. Publicação

… documentos.

A maioria afirma que uma identidade melhor seria 'sistema de gerenciamento de conteúdo'.

Concedido que este termo tende a ser incluído em artigos escritos por fornecedores de CMS (e a esse respeito, este artigo não seria diferente), mas se examinarmos o uso de precisão – um CMS é, afinal, um rótulo apropriado para um HAT.

Ele literalmente ajuda os escritores técnicos a criar documentos de ajuda.

No que diz respeito a apontar exatamente o que queremos dizer com ajuda – suponho que não existam regras rígidas e rápidas sobre o quão amplo você pode levar isso.

Dependeria muito de:

1. Quão profundamente os fabricantes de software conhecem a disciplina de redação técnica e;
2. Quão persuadidos eles estavam para cumprir a necessidade

Na maioria dos casos, o HAT se concentra em acertar os conceitos básicos de redação e editorial.

E ofereça um pouco de modelagem, estilo e codificação no topo.

Mas a questão é…

…essas funções sozinhas são suficientes para atender às altas demandas do escritor técnico moderno?

Por que não perguntamos apenas alguns?…

1. Neste trecho de feedback, o entrevistado (um redator técnico) faz uma revisão comparativa de uma funcionalidade HAT tradicional versus um CMS tradicional (Drupal):

“Como administrador no Drupal, você pode visualizar uma lista de páginas, mas só pode editar as propriedades de uma página por vez. Não há seleção múltipla nem arrastar e soltar . Portanto, o gerenciamento de tópicos pode ser muito trabalhoso.”

“Se você excluir uma página, todos os links que apontam para ela serão quebrados e não haverá mensagens para avisá-lo.

Ao criar um link em uma página, você precisa saber o caminho e o nome da página de destino – não há listas úteis de páginas disponíveis.”

“Pronto para uso, não há editor WYSIWYG . Para a maioria dos usuários do HAT, isso é obrigatório. Você só pode escrever seu conteúdo em html completo/filtrado.”

(Fonte: Folha de Cerejeira)

2. Neste comentário, outro escritor técnico de carreira discutiu duas funções ideais que ele acha que estariam em tendência para o futuro do software HAT:

“Pesquisa de fatos: quando um usuário clica na guia de pesquisa e pesquisa um item, o usuário pode restringir os resultados da pesquisa usando facetas semelhantes, conforme mostrado na imagem a seguir.”

“Usar qualquer uma das ferramentas de autoria padrão – Flare, RoboHelp, Author-It, Doc-to-Help – deixa você com o modelo ridículo de um único autor trabalhando de um único ponto de vista de uma única organização tentando reunir um oceano de em formação. Como esse modelo é insustentável e inescalável, os HATs desaparecerão em favor de tecnologias colaborativas de autoria baseadas na web .”

(Fonte: Eu prefiro estar escrevendo blog)

Os insights fornecidos acima expandem o alcance do sentido tradicional de um HAT para incluir uma plataforma mais dinâmica e colaborativa para aumentar a produtividade da redação técnica.

Você deve considerar o uso de um Component Content Management System (CCMS) para criação de ajuda?

Controle de presentes de granularidade.

E no campo da redação técnica, a vantagem de maior controle dentro do ciclo de produção gera eficiências que se traduzem em maior ROI do projeto.

É exatamente aí que entra um sistema de gerenciamento de conteúdo de componentes.

O que é um sistema de gerenciamento de conteúdo de componentes (CCMS)?

Um sistema de gerenciamento de conteúdo componente é um CMS cujos itens de conteúdo não são páginas e postagens, mas sim trechos, parágrafos e partes de conteúdo.

Da mesma forma, quando você produz um novo conteúdo em um CMS, você inicia uma nova página ou postagem.

Com um CCMS, você iniciaria um novo componente (parte de uma página ou postagem).

Muitas partes formam uma página inteira, então o resultado final de páginas e posts inteiros é o mesmo, mas a forma como são feitas é dividida em pequenos pedaços.

Por quê?

Economias de escala.

Claro que é indiscutivelmente mais trabalhoso construir páginas com base em várias partes (cada uma com seus próprios metadados, dependências etc.) do que uma parte inteira de fluxo livre.

Mas, com projetos de conteúdo complexo em grande escala com muitos cruzamentos tópicos e referências internas, a reutilização e a intercambialidade granular em um nível de componente…

…um CCMS oferece uma grande vantagem a longo prazo para equipes de redação.

Ou seja, fazer as coisas com mais rapidez e precisão.

Artigos recomendados de conselhos sobre ferramentas de criação de ajuda

Escolher a ferramenta de autoria de ajuda mais adequada é mais do que apenas uma comparação de 'recursos e benefícios'.

Para obter o melhor resultado, você precisa se aprofundar na usabilidade. Compreender os fluxos de trabalho e o gerenciamento de tarefas ajudará você a ver os prós e os contras apresentados por cada solução.

Para ajudá-lo em alguns conselhos recomendados por colegas sobre o assunto, reunimos esta lista rápida de artigos úteis relacionados ao HAT:

1. Por que os HATs vão desaparecer
2. 5 razões pelas quais eu recomendo usar uma ferramenta de autoria baseada em nuvem
3. O que um HAT lhe dá sobre o Drupal?
4. 6 razões para usar o software HAT
5. 5 tipos de ferramentas de autoria que escritores técnicos usam

Os autores dos artigos acima falam com bastante conhecimento sobre o assunto HAT e dão várias dicas internas sobre como tomar a decisão certa.

Quais são as principais características de um HAT?

Então, estamos gradualmente firmando nossa visão sobre os HATs, o que eles fazem e as vantagens externas que devemos considerar além da abordagem tradicional.

Mas ainda valeria a pena termos uma referência abrangente para todas as coisas que um HAT deos.

Desta forma, podemos comparar 'maçãs por maçãs' ao considerar uma escolha de investimento.

Aqui está uma lista das funções de software HAT mais comuns e inclusivas:

• Vários formatos de entrada e saída : importe e exporte dados usando muitos tipos de arquivo
• Processador de texto completo : editor WYSIWYG baseado em código e visual
• Construir tags : atribua tags tópicas para relacionar os artigos tematicamente
• Modelos de tópicos : obtenha uma vantagem em cada peça com modelos pré-fabricados  
• Marcador de sintaxe: destaques úteis sobre questões gramaticais para resolver  
• Mesclar tags para meta-informações em todo o projeto : insira snippets reutilizáveis ​​com facilidade usando tags de mesclagem, economizando tempo e limitando o erro
• HTML, CSS, Javascript personalizados: aplique toques personalizados para funcionar e projetar com código web personalizado
• Mesclar conteúdo do projeto : combinando conteúdo dentro do mesmo projeto para produzir um resultado combinado.  
• Tema da web personalizável : interruptores, slides e caixas de seleção para aperfeiçoar o frontend da ferramenta para melhorar a experiência do usuário
• Repositório de mídia : uma área de armazenamento organizada para todas as suas imagens, PDFs, arquivos de áudio e vídeo  
• Interface de usuário fácil : simples de usar com todos os controles relevantes em distância e posicionamento fáceis de alcançar  
• Tradução : entrega em vários idiomas
• Índice : links de salto fáceis de usar em cada artigo para leitura rápida do conteúdo  

Entre os HATs dedicados, os pontos acima cobrem a maior parte do que seria esperado sob o capô.

Benefícios de construir um HAT personalizado

Se eu tivesse que resumir o principal benefício de construir um HAT personalizado, eu diria:

Domínio do seu próprio conjunto de ferramentas.

Conjunto de ferramentas personalizado

Quando você tem 'o que você quer', 'onde e como você quer' como profissional, o retorno do investimento em tempo economizado e melhores resultados é imensurável.

Você simplesmente não pode comparar a experiência de usar ferramentas feitas 'perfeitas' para o sucesso versus um conjunto de instrumentos genéricos 'make do'.

Portanto, personalizar seu próprio HAT pode envolver trabalho e confusão iniciais consideráveis.

Mas, a longo prazo, o cenário está definido para você bater seu recorde pessoal em cada projeto.

Expansível

Esperar por melhorias no roadmap ou ser espremido em atualizações premium não precisa acontecer com um HAT personalizado.

Claro, você será responsável pela manutenção e melhoria da ferramenta, mas por apenas um pouco de tempo de bricolage você pode estender adequadamente a vida útil do seu HAT.

Em suma, à medida que seu HAT melhora, seus resultados também aumentam.

Melhor desempenho geral

Um HAT personalizado removerá todos os aborrecimentos mesquinhos ou obstrutivos do seu fluxo de trabalho de redação técnica.

Você remove todos os gargalos e drenos de tempo, substituindo-os por recursos, opções e configurações que dão à sua corrida para terminar projetos um vento a seguir.

Você vai facilmente pip o que você pensava que era possível anteriormente.

Criando uma ferramenta de criação de ajuda do WordPress com o plug-in Heroic Knowledge Base

Então, agora, se você está pronto para enfrentar novas águas e se aventurar a fazer seu próprio CHAPÉU – nós temos a solução certa para você.

Fácil de usar.

Construído em uma plataforma usada por mais de 40% de todos os sites online.

Com todos os melhores recursos – e muito mais.

Aqui está… nosso guia rápido sobre quem fazer um HAT usando o WordPress.

E a melhor parte é que não há nenhum código envolvido. Este método é muito amigável para iniciantes.

Aqui está o alinhamento:

1. Organização e categorização de páginas e arquivos
2. Pesquisa, votação, feedback e análise
3. Replicação de componentes de perguntas frequentes
4. Helpdesk para tratamento de consultas via tickets
5. Índice da página de índice
6. Biblioteca de termos do glossário

Um ponto rápido sobre “por que o WordPress”.

Para a maioria dos profissionais, ter as melhores ferramentas para o trabalho (independentemente do nome) é o mais importante.

Semântica ou xingamentos não contam muito, pois você fica mergulhado em entregas e precisa de um motor com algum torque para desenterrá-lo.

É aqui que o WordPress é ideal como plataforma para criar um HAT personalizado.

Em primeiro lugar, ele marca todas as caixas essenciais no alinhamento de funções mencionado anteriormente neste artigo. E faz isso com facilidade, direto da caixa com sua oferta principal.

Recursos como WYSIWYG e HTML, CSS e codificação JS são recursos padrão oferecidos pelo WordPress (o sistema de gerenciamento de conteúdo líder mundial).

Mas o WordPress também hospeda meio trilhão de dólares em hospedagem, plugins e economia de temas.

Esses jogadores são responsáveis ​​por fornecer as extensões de 1ª classe e assistência de desempenho que tornam a ferramenta adequada ao propósito.

Em suma, o WordPress e seus companheiros de plug-in são uma oferta de equipe dos sonhos de um HAT para qualquer escritor técnico que queira fazer DIY sua própria configuração.

Aqui está uma visão geral de nossas etapas recomendadas para criar seu próprio mercado online usando o WordPress:

Página inicial do diretório com categorias em silos: uma página central que serve como seu índice de biblioteca de referência de projetos concluídos e recursos pesquisados. Um local completo para acessar seu registro de redação técnica.

Use o plug-in Heroic Knowledge Base para produzir um alinhamento automaticamente vinculado e discriminado de seu conteúdo HAT publicado anteriormente.

Pesquisa, votação, feedback e análise: tomando nota do pedido de colaboração de nossos autores técnicos colaboradores anteriormente no artigo, integramos dinamismo e engajamento nos recursos de nossa solução WordPress HAT. Fornecer pesquisa, feedback e insights só ajudará a desenvolver melhorias ainda maiores.

Use o plug-in Heroic Knowledge Base para habilitar aprimoramentos de pesquisa do usuário para direcionar um roteiro de melhoria iterativo para o produto.

Replicação de componentes de perguntas frequentes : configure o controle granular de componentes em perguntas frequentes, obtendo a vantagem de ter uma produção mais enxuta para dimensionar projetos maiores.

Use o plugin Heroic FAQs para equipar seu HAT com componentes reutilizáveis ​​embutidos com instalação simples e código sero.

Caixa de entrada heroica para lidar com consultas por meio de tickets: para enviar tickets de suporte ao usuário de forma conveniente, oferecendo a você um canal de ajuda por e-mail responsivo que fica dentro da sua instalação do WordPress.

Use o plugin Heroic Inbox para integrar sua caixa de entrada de e-mail comercial ao painel de administração do WordPress. Isso oferece um hub de comunicações unificado dentro do seu HAT, economizando tempo perdido navegando em um fluxo de trabalho desarticulado.

Índice heroico: links de salto para facilitar a leitura rápida de seus artigos ajudam os leitores a digerir informações e extrair valor. Torne suas peças ainda mais consumíveis com um ToC clássico.

Use o Índice Heroico para adicionar um índice de preenchimento automático a cada um de seus artigos.

Glossário Heroico: compile uma lista AZ de termos úteis como um atalho para acessar as definições de palavras-chave em um projeto, mantendo você ágil enquanto escreve seu novo projeto.

Use o plugin Heroic Glossary para instalar um glossário pesquisável no seu WordPress HAT – sem suor e (novamente) sem código.

Aspose.Words: converta instantaneamente posts ou páginas do WordPress em arquivos DOC ou DOCX e vice-versa. Preencha as lacunas do fluxo de trabalho e torne seu novo sistema compatível com GDocs legados ou ativos de documentos do Word.

Use o plugin Aspose.Words para habilitar a conversão bidirecional de arquivos entre WordPress e GDocs ou Word.

Syntax Highlighter Evolved: destaque o código da Web ao fazer edições personalizadas, ajudando você a se concentrar nos detalhes sem distrações.

Use o Syntax Highlighter Evolved para tornar o código bonito enquanto você faz suas edições com experiência na web.

Conclusão

HATs feitos com propósito nestes dias de CMSs avançados provavelmente estão reinventando a roda.

Na verdade, não há muito (se houver) que mesmo o HAT mais avançado possa fazer o que um CMS com alguma configuração não poderia fazer.

Além disso, com um CMS, você tem funcionalidades adicionais que adicionam vantagens a uma oferta já competitiva.

O potencial adicional fornecido por um CMS (o WordPress líder de mercado com seus plugins) pode estender uma solução HAT semelhante para além das suas expectativas.

Muito espaço para coçar suas próprias coceiras e continuar inovando com o WordPress – além de não precisar de codificação.

Um ecossistema de plugins de terceiros em rápida expansão suporta a vantagem de marketshare do WordPress com produtos especializados para expandir os limites das possibilidades.

Em suma, estamos convencidos de que, se você deseja fazer um investimento em HAT personalizado à prova de futuro, o WordPress CMS é a plataforma digital ideal.

Por que não começar hoje?