Cómo construir una herramienta de autoría de ayuda usando WordPress

Un buen redactor técnico nunca está lejos de su herramienta de creación de ayuda (HAT) de confianza.

El caballo de batalla del oficio de redacción técnica: una herramienta de autoría de ayuda, toma la tensión y transforma el arte de 'hacer que las cosas complejas sean simples'... bueno, pan comido.

Los HAT son maximizadores de productividad para escritores técnicos. 10x escritores técnicos tienen este lado de su juego firmemente establecido.

Con tantas fases de rondas iterativas de modelado y edición de copias para que aterrice como un ajuste perfecto para el propósito...

…realmente necesita un HAT que trabaje junto a usted y lo ayude a concentrar todos sus esfuerzos en formular el mejor producto literario.

El concepto de HAT no es nuevo.

Han estado alrededor.

Y algunos podrían decir, si fueran una foto familiar, podrían haberse vuelto un poco desgastadas, sepia e incluso desvanecidas en relevancia.

Por ejemplo, en muchos casos, poseer un editor WYSIWYG se considera una característica premium.

Pero pensando más lateralmente, ¿hay algún caso para aplicar la versatilidad y los beneficios transferibles multifacéticos de un sistema de administración de contenido (CMS) para catapultar a los HAT al siglo XXI?

Diríamos, en el caso de WordPress CMS, la plataforma de creación web líder en el mundo y el software CMS más popular por una milla de país...

…la respuesta es sí.

Pero no se fíe solo de nuestra palabra, ¿por qué no se toma los siguientes minutos para profundizar un poco más en por qué WordPress CMS es lo mejor que les ha pasado a los escritores técnicos desde el café espresso de pan rebanado ?

Aquí está, la guía de HeroThemes para crear una herramienta de creación de ayuda usando WordPress.

Las demandas típicas del escritor técnico de hoy

La escritura técnica actual abarca muchos temas especializados.

• política pública gubernamental
• informática informática
• inversión financiera
• Bienes raíces

…la lista continua.

Pero son comunes en todas partes las exigencias rigurosas de ser traductores de complejidad para el mundo técnico son las tareas del día a día.

Según Khidr Suleman, redactor técnico, diseño de servicios y garantía en el Servicio Digital del Gobierno del Reino Unido, las siguientes son sus funciones diarias habituales:

• participar en la investigación de usuarios
• creación de estrategias de contenido
• presentación de planes a los principales interesados
• diseño y creación de prototipos de viajes de usuario
• discutir, editar y (por supuesto) escribir contenido

Bastante diverso.

Sin embargo, por último, pero no menos importante, en esa lista estaba (por supuesto) hacer lo que realmente hacen.

Pero la escritura (y especialmente la escritura técnica) es un proceso más que una actividad.

Una carrera de relevos de deberes que conducen colectivamente a la entrega de documentación.

En pocas palabras, la escritura técnica se puede describir como el proceso de "... capturar, organizar y mantener el conocimiento sobre los sistemas de software que cambian rápidamente" - Atom Bank

Y como tal, una característica común de un día en la vida de un escritor técnico es el manejo de repositorios y bases de conocimiento.

Registrar citas o fragmentos de comentarios de expertos, por ejemplo. Además de recuperar pepitas de oro en forma de hechos o datos para validar argumentos.

En resumen, la facilidad de almacenamiento de datos, búsqueda y ubicación o descubrimiento, además de la escritura, también son funciones aliadas importantes de una herramienta de creación de ayuda.

¿Qué es una herramienta de creación de ayuda en 2022?

Si se cree en la mayoría de las definiciones de Google de la página 1 para la herramienta de creación de ayuda, una descripción precisa debe incluir:

1. Haciendo
2. Gerente
3. Publicación

…documentos.

La mayoría afirma que una mejor identidad sería 'sistema de gestión de contenido'.

Es cierto que este término tiende a incluirse en artículos escritos por proveedores de CMS (y en ese sentido, este artículo no sería diferente), pero si examinamos el uso preciso, un CMS es, después de todo, una etiqueta apropiada para un HAT.

Literalmente ayuda a los escritores técnicos a crear documentos de ayuda.

En cuanto a señalar exactamente lo que queremos decir con ayuda, supongo que no hay reglas estrictas y rápidas sobre cuán ampliamente podría tomar eso.

Realmente dependería de:

1. Cuán profundamente conocen los fabricantes de software la disciplina de redacción técnica, y;
2. Cuán persuadidos estaban de satisfacer la necesidad

En la mayoría de los casos, HAT se enfoca en lograr que los conceptos básicos de redacción y redacción sean correctos.

Y ofrezca un poco, plantillas, estilo y codificación en la parte superior.

Pero la pregunta es…

... ¿son estas funciones por sí solas suficientes para satisfacer las exigentes demandas del escritor técnico de hoy en día?

¿Por qué no solo preguntamos algunos?...

1. En este extracto de comentarios, el encuestado (un escritor técnico) brinda una revisión comparativa de una funcionalidad HAT tradicional frente a un CMS tradicional (Drupal):

“Como administrador en Drupal, puede ver una lista de páginas, pero solo puede editar las propiedades de una página a la vez. No hay selección múltiple ni arrastrar y soltar . Por lo tanto, la gestión de temas puede ser muy laboriosa”.

“Si elimina una página, todos los enlaces que apuntan a ella se romperán y no hay mensajes para advertirle.

Al crear un enlace en una página , debe conocer la ruta y el nombre de la página de destino ; no hay listas útiles de páginas disponibles”.

“Fuera de la caja, no hay un editor WYSIWYG . Para la mayoría de los usuarios de HAT, esto es imprescindible. Solo puede escribir su contenido en html completo/filtrado”.

(fuente: hoja de cerezo)

2. En este comentario, otro escritor técnico de carrera discutió dos funciones ideales que cree que estarían de moda para el futuro del software HAT:

“Búsqueda de hechos: cuando un usuario hace clic en la pestaña de búsqueda y busca un elemento, el usuario puede restringir los resultados de la búsqueda utilizando facetas similares, como se muestra en la siguiente imagen”.

“Usar cualquiera de las herramientas de creación estándar (Flare, RoboHelp, Author-It, Doc-to-Help) lo deja con el modelo ridículo de un solo autor que trabaja desde un único punto de vista desde una sola organización que intenta reunir un océano de información. Debido a que ese modelo es insostenible y no escalable, los HAT se desvanecerán en favor de las tecnologías de creación colaborativas basadas en la web ”.

(Fuente: Preferiría estar escribiendo blog)

Las ideas proporcionadas anteriormente amplían el ámbito del sentido tradicional de un HAT para incluir una plataforma más dinámica y colaborativa para mejorar la productividad de la redacción técnica.

¿Debería considerar usar un Sistema de administración de contenido de componentes (CCMS) para la creación de ayuda?

Control de regalos de granularidad.

Y en el campo de la redacción técnica, la ventaja de un mayor control dentro del ciclo de producción genera eficiencias que se traducen en un mayor ROI del proyecto.

Aquí es exactamente donde entra en juego un sistema de gestión de contenido de componentes.

¿Qué es un sistema de gestión de contenido de componentes (CCMS)?

Un sistema de administración de contenido de componentes es un CMS cuyos elementos de contenido no son páginas y publicaciones, sino fragmentos, párrafos y porciones de contenido.

De la misma manera, cuando llega a producir una nueva pieza de contenido en un CMS, comenzaría una nueva página o publicación.

Con un CCMS, comenzaría un nuevo componente (parte de una página o publicación).

Muchas partes forman una página completa, por lo que el resultado final de páginas y publicaciones completas es el mismo, pero la forma en que se crean se divide en partes pequeñas.

¿Por qué?

Economías de escala.

Seguro que podría decirse que es más trabajo construir páginas basadas en múltiples piezas (cada una con sus propios metadatos, dependencias, etc.) en lugar de una sola pieza completa que fluye libremente.

Pero, con proyectos de contenido complejo a gran escala con muchos cruces temáticos y referencias internas, la reutilización y la intercambiabilidad granular a nivel de componente...

…un CCMS ofrece una gran ventaja a largo plazo para los equipos de redacción.

Es decir, hacer las cosas más rápido y con mayor precisión.

Artículos de asesoramiento de la herramienta de creación de ayuda recomendados

Elegir la herramienta de creación de ayuda que mejor se adapte es más que una simple comparación de "características y beneficios".

Para obtener el mejor resultado, debe profundizar en la usabilidad. Comprender los flujos de trabajo y la gestión de tareas lo ayudará a ver los pros y los contras que presenta cada solución.

Para ayudarlo con algunos consejos recomendados por pares sobre el tema, hemos reunido esta lista rápida de artículos útiles relacionados con HAT:

1. Por qué los sombreros se desvanecerán
2. 5 razones por las que recomiendo usar una herramienta de creación basada en la nube
3. ¿Qué te aporta un HAT sobre Drupal?
4. 6 razones para usar el software HAT
5. 5 tipos de herramientas de creación que utilizan los escritores técnicos

Los autores de los artículos anteriores hablan con bastante conocimiento sobre el tema de HAT y brindan una serie de consejos internos para tomar la decisión correcta.

¿Cuáles son las principales características de un HAT?

Por lo tanto, estamos reafirmando gradualmente nuestra opinión sobre los HAT, lo que hacen y las ventajas externas que debemos considerar además del enfoque tradicional.

Pero aún así valdría la pena tener una referencia completa de todas las cosas que un HAT deos.

De esta manera podemos comparar 'manzanas por manzanas' al considerar una opción de inversión.

Aquí hay una lista de las funciones de software HAT más comunes e inclusivas:

• Múltiples formatos de entrada y salida : importe y exporte datos usando muchos tipos de archivos
• Procesador de texto con todas las funciones : editor WYSIWYG visual y basado en código
• Cree etiquetas : asigne etiquetas temáticas para relacionar artículos temáticamente
• Plantillas de temas : obtenga una ventaja inicial en cada pieza con plantillas prefabricadas  
• Resaltador de sintaxis: aspectos destacados útiles sobre problemas gramaticales para resolver  
• Combine etiquetas para metainformación de todo el proyecto : inserte fragmentos reutilizables con facilidad usando etiquetas de combinación, ahorre tiempo y limite los errores
• HTML personalizado, CSS, Javascript: aplique toques personalizados a la función y el diseño con código web personalizado
• Fusionar contenido del proyecto : combinar contenido dentro del mismo proyecto para producir un resultado combinado.  
• Tema web personalizable : interruptores, diapositivas y casillas de verificación para perfeccionar la interfaz de la herramienta para mejorar su experiencia de usuario
• Repositorio de medios : un área de almacenamiento ordenada para todas sus imágenes, PDF, archivos de audio y video  
• Interfaz de usuario fácil : fácil de usar con todos los controles relevantes en distancia y posicionamiento fáciles de alcanzar  
• Traducción : entrega en varios idiomas
• Tabla de contenido : enlaces de salto fáciles de usar en cada artículo para leer rápidamente el contenido  

Entre los HAT dedicados que existen, los puntos anteriores cubren la mayor parte de lo que se esperaría debajo del capó.

Beneficios de construir un HAT personalizado

Si tuviera que resumir el principal beneficio de construir un SOMBRERO personalizado, diría:

Dominio de su propio conjunto de herramientas.

Conjunto de herramientas a medida

Cuando tiene 'lo que quiere', 'dónde y cómo lo quiere' como profesional, el retorno de la inversión en tiempo ahorrado y mejores resultados es inconmensurable.

Simplemente no puede comparar la experiencia de usar herramientas hechas 'perfectamente' para el éxito frente a un conjunto de instrumentos genéricos 'fáciles'.

Por lo tanto, personalizar su propio SOMBRERO puede implicar un trabajo y un alboroto iniciales considerables.

Pero a la larga, el escenario está preparado para que superes tu mejor marca personal en cada proyecto.

Ampliable

No es necesario esperar a que se produzcan mejoras en el mapa de ruta o verse presionado por actualizaciones premium con un HAT personalizado.

Claro, usted mismo será responsable del mantenimiento y la mejora de la herramienta, pero con solo un poco de tiempo de bricolaje puede prolongar adecuadamente la vida útil de su HAT.

En resumen, a medida que su HAT mejore, también lo harán sus resultados.

Mejor rendimiento general

Un HAT personalizado eliminará todas las molestias insignificantes u obstructivas de su flujo de trabajo de escritura técnica.

Elimina todos los cuellos de botella y pérdidas de tiempo, reemplazándolos con características, opciones y configuraciones que le dan un impulso a su carrera para terminar proyectos.

Obtendrás fácilmente lo que creías que antes era posible.

Creación de una herramienta de creación de ayuda de WordPress con el complemento Heroic Knowledge Base

Entonces, a estas alturas, si está listo para desafiar nuevas aguas y dar el paso para hacer su propio SOMBRERO, tenemos la solución perfecta para usted.

Fácil de usar.

Construido sobre una plataforma utilizada por más del 40% de todos los sitios web en línea.

Con todas las mejores características, y más.

Aquí está… nuestra guía rápida sobre quién hacer un SOMBRERO usando WordPress.

Y la mejor parte es que no hay código involucrado en absoluto. Este método es muy amigable para principiantes.

Aquí está la alineación:

1. Organización y categorización de páginas y archivos.
2. Búsqueda, votación, comentarios y análisis
3. Duplicación de componentes de preguntas frecuentes
4. Helpdesk para el manejo de consultas a través de tickets
5. índice de la página de la tabla de contenido
6. Biblioteca de términos del glosario

Un punto rápido sobre "por qué WordPress".

Para la mayoría de los profesionales, tener las mejores herramientas para el trabajo (independientemente de cómo se llame) es lo más importante.

La semántica o los insultos no cuentan mucho, ya que te sumerges en los entregables y necesitas un motor con algo de torque para sacarte.

Aquí es donde WordPress es ideal como plataforma para hacer un SOMBRERO personalizado.

En primer lugar, marca todas las casillas esenciales en la lista de funciones mencionadas anteriormente en este artículo. Y lo hace con facilidad, nada más sacarlo de la caja con su oferta principal.

Funciones como WYSIWYG y HTML, CSS y codificación JS son funciones estándar que ofrece WordPress (el sistema de administración de contenido líder en el mundo).

Pero WordPress también alberga una economía de hosting, complementos y temas de medio billón de dólares.

Estos reproductores son responsables de ofrecer las extensiones de primera clase y la asistencia de rendimiento que hacen que la herramienta se adapte a su propósito.

Con todo, WordPress y sus complementos complementarios constituyen una oferta de equipo de ensueño de un HAT para cualquier escritor técnico que desee crear su propia configuración.

Aquí hay una descripción general de nuestros pasos recomendados para construir su propio mercado en línea usando WordPress:

Página de inicio del directorio con categorías aisladas: una página central que sirve como índice de su biblioteca de referencia de proyectos completados y recursos investigados. Una ubicación perfecta para acceder a su registro de escritura técnica.

Use el complemento Heroic Knowledge Base para producir una lista detallada y vinculada automáticamente de su contenido HAT publicado anteriormente.

Búsqueda, votación, comentarios y análisis: tomando nota del llamado a la colaboración de nuestros autores técnicos contribuyentes de antes en el artículo, hemos integrado el dinamismo y el compromiso dentro de las características de nuestra solución WordPress HAT. Proporcionar búsqueda, comentarios e información solo ayudará a desarrollar mayores mejoras.

Use el complemento Heroic Knowledge Base para habilitar las mejoras de investigación del usuario para dirigir una hoja de ruta de mejora iterativa para el producto.

Duplicación de componentes de preguntas frecuentes : configure el control granular de componentes en las preguntas frecuentes, lo que le brinda la ventaja de tener una producción más eficiente para escalar proyectos más grandes.

Use el complemento Heroic FAQs para equipar su HAT con componentes reutilizables incorporados con una instalación simple y código de sero.

Bandeja de entrada heroica para manejar consultas a través de tickets: para enviar convenientemente tickets de soporte al usuario, brindándole un canal de ayuda de correo electrónico receptivo que se encuentra dentro de su instalación de WordPress.

Use el complemento Heroic Inbox para integrar su bandeja de entrada de correo electrónico comercial en su panel de administración de WordPress. Esto le brinda un centro de comunicaciones unificado dentro de su HAT, lo que le ahorra el tiempo perdido que de otro modo pasaría navegando por un flujo de trabajo inconexo.

Tabla de contenido heroica: los enlaces de salto para facilitar la lectura rápida de sus artículos ayudan a los lectores a digerir información y extraer valor. Haga que sus piezas sean aún más consumibles con un ToC clásico.

Use la tabla de contenido heroica para agregar una tabla de contenido autocompletada a cada uno de sus artículos.

Glosario heroico: compile una lista de la A a la Z de términos útiles como acceso directo para acceder a definiciones de palabras clave en un proyecto, manteniéndolo ágil mientras escribe su nuevo proyecto.

Use el complemento Heroic Glossary para instalar un glosario de búsqueda en su SOMBRERO de WordPress, sin sudor y (nuevamente) sin código.

Aspose.Words: convierta instantáneamente publicaciones o páginas de WordPress en archivos DOC o DOCX y viceversa. Supere las brechas en el flujo de trabajo y haga que su nuevo sistema sea compatible con los activos de documentos GDocs o Word heredados.

Use el complemento Aspose.Words para habilitar la conversión bidireccional de archivos entre WordPress y GDocs o Word.

Resaltador de sintaxis evolucionado: haga que el código web se destaque a medida que realiza ediciones personalizadas, lo que lo ayuda a concentrarse en los detalles sin distracciones.

Use Syntax Highlighter Evolved para hacer que el código sea hermoso a medida que realiza ediciones inteligentes en la web.

Conclusión

Los HAT especialmente diseñados en estos días de CMS tan avanzados probablemente estén reinventando la rueda.

En realidad, no hay mucho (si es que hay algo) que incluso el HAT con funciones más avanzadas pueda hacer que un CMS con alguna configuración no pueda hacer.

Además, con un CMS, tiene una funcionalidad adicional que agrega ventajas a una oferta ya competitiva.

El potencial adicional proporcionado por un CMS (el WordPress líder en el mercado con sus complementos) puede extender una solución HAT similar más allá de sus expectativas.

Mucho espacio para rascarse sus propios picores y continuar innovando con WordPress, además de que no se necesita codificación.

Un ecosistema de complementos de terceros en rápida expansión respalda la ventaja de cuota de mercado de WordPress con productos especializados para ampliar los límites de la posibilidad.

En general, estamos convencidos de que si está buscando hacer una inversión en HAT personalizado a prueba de futuro, WordPress CMS es la plataforma digital ideal.

¿Por qué no empezar hoy?