Trusted WordPress tutorials, when you need them most.
Beginner’s Guide to WordPress
Copa WPB
25 Million+
Websites using our plugins
16+
Years of WordPress experience
3000+
WordPress tutorials
by experts

Cómo añadir documentación en WordPress (paso a paso)

Nota editorial: Ganamos una comisión de los enlaces de socios en WPBeginner. Las comisiones no afectan a las opiniones o evaluaciones de nuestros editores. Más información sobre Proceso editorial.

¿Está buscando una forma de añadir documentación en WordPress?

Añadir documentación a su sitio web facilita a los usuarios la comprensión del uso de sus productos o servicios. Esto puede aumentar la participación de los usuarios, mejorar el SEO y reducir los tiques / entradas de soporte en su sitio web.

En este artículo, le mostraremos cómo añadir fácilmente documentación en WordPress, paso a paso.

Adding documentation in WordPress

¿Por qué añadir documentación en WordPress?

La documentación es el contenido de su sitio web de WordPress que proporciona información sobre cómo utilizar sus productos/servicios, incluidas sus características, nuevas versiones, extensiones, etc.

La documentación de WordPress puede incluir tutoriales prácticos, guías, FAQ, bases de conocimiento y documentación de la API.

Por ejemplo, si tienes una tienda online que vende música, puedes crear documentación en la que se detalle cómo descargar la música, renovar las licencias o crear una lista de reproducción.

Website documentation preview

Añadir documentación en WordPress puede mejorar la experiencia del usuario al facilitar que los clientes descubran diferentes características del producto, encuentren las causas de sus problemas y los depuren ellos mismos. Esto puede incluso reducir el número de tiques / entradas de soporte para su sitio.

La documentación también puede mejorar su posicionamiento SEO al proporcionar contenido adicional que Google y otros motores de búsqueda pueden indexar y mostrar en los resultados de búsqueda.

Dicho esto, veamos cómo añadir fácilmente documentación en WordPress, paso a paso.

Cómo añadir documentación en WordPress

Puede añadir fácilmente documentación en WordPress utilizando el plugin Heroic KB.

Es el mejor plugin de base de conocimiento de WordPress en el mercado que añade una base de conocimiento de búsqueda a su sitio existente. Viene con una característica de búsqueda AJAX, arrastrar y soltar el contenido de pedidos, adjuntos de artículos, y mucho más.

Además, la herramienta incorpora análisis y una característica de respuesta / comentario / opinión de los usuarios que le permite recopilar información para mejorar la documentación existente.

Incluso incluye la característica Heroic AI Assistant, que le permite añadir fácilmente un chatbot personalizado a su sitio web. El chatbot se entrena directamente a partir de tu base de conocimientos para que pueda ofrecer respuestas precisas y personalizadas a tus clientes.

Paso 1: Configurar los ajustes generales de Heroic KB

Primero, necesitas instalar y activar el plugin Heroic KB. Para obtener instrucciones detalladas, consulte nuestra guía paso a paso sobre cómo instalar un plugin de WordPress.

Una vez activado, visite la página Heroic KB ” Ajustes desde la barra lateral del administrador de WordPress y cambie a la pestaña ‘Licencia y actualizaciones’.

Aquí, introduce la clave de licencia de tu plugin y haz clic en el botón “Guardar cambios”. Puedes obtener esta información desde tu cuenta en el sitio web de Heroic KB.

Heroic KB license key

Después de añadir la clave de licencia, cambie a la pestaña ‘Inicio y General’ de la columna de la izquierda. Debe seleccionar la página de inicio de la documentación en el menú desplegable situado junto a la opción ‘Página de inicio KB’.

Si eliges la opción ‘Knowledge Base Archive’, entonces Heroic KB creará una nueva página para tu documentación en www.example.com/knowledge-base.

Sin embargo, si desea añadir su documentación en una página que ya ha creado, puede elegir esa opción en el menú desplegable.

A continuación, también puede escribir el texto de cabecera que se mostrará en la parte superior de su página de documentación.

Choose a home page and header text for the documentation

Una vez hecho esto, sólo tiene que marcar la opción “Migas de pan” para activarla.

En una base de conocimientos, las migas de pan son un tipo de ayuda a la navegación que permite a los usuarios ver cómo han llegado a la página actual y navegar a páginas anteriores como ésta: Inicio ” Productos ” Instalación.

A continuación, también puede elegir en el menú desplegable el número de columnas de categorías que se mostrarán en su página de documentación.

A continuación, marque / compruebe la opción “Mostrar recuentos de categorías KB” si desea mostrar el número de artículos escritos para cada categoría.

Choose the number for category columns for the documentation

A continuación, seleccione el número de artículos que deben mostrarse en cada categoría de la página de inicio de la documentación en el menú desplegable “Artículo de categoría KB”.

A continuación, puede marcar las casillas “Ocultar categorías vacías” y “Ocultar artículos no categorizados”. De este modo, ni las categorías actualmente vacías ni los artículos sin categorizar se mostrarán en la página de inicio de su documentación.

A continuación, puede restringir el acceso a la documentación de WordPress solo a los usuarios conectados desde el menú desplegable “Restringir acceso”.

Una vez que hayas terminado, sólo tienes que hacer clic en el botón “Guardar cambios” para guardar tus ajustes.

Restrict documentation access

Paso 2: Configurar categorías, etiquetas y ajustes de artículos

Ahora, cambie a la pestaña “Categorías y etiquetas” de la columna de la izquierda. Aquí puede elegir cómo ordenar sus categorías y etiquetas y el número de artículos que se mostrarán para cada taxonomía.

También puede marcar / comprobar la casilla “Extracto de artículo” si desea mostrar un fragmento de artículo debajo de cada archivo de taxonomía en su documentación.

A continuación, basta con hacer clic en el botón “Guardar cambios” y pasar a la pestaña “Artículo”.

Configure categories and tags settings in the documentation

Desde aquí, puede marcar diferentes casillas para activar una sección de comentarios debajo de sus artículos de documentación, mostrar las biografías de los autores o mostrar otros artículos relacionados debajo de cada tutorial.

Después de elegir, sólo tienes que hacer clic en el botón “Guardar cambios” para guardar tus ajustes.

Enable comments and author bios for documentation articles

Paso 3: Establecer los ajustes de búsqueda y slug de la base de conocimientos

Ahora, cambie a la pestaña “Búsqueda” y marque la casilla “Enfoque de búsqueda” si desea que el ratón del usuario se sitúe automáticamente en el cuadro de búsqueda de documentación cuando se cargue la página.

A continuación, también puede añadir texto de marcador de posición para el cuadro de búsqueda, mostrar extractos de artículos en los resultados de búsqueda e incluso activar el plugin para resaltar el término de búsqueda en los resultados.

Consejo de experto: ¿Estás buscando una forma de establecer una búsqueda avanzada en todo tu sitio web? Consulte nuestra guía sobre cómo mejorar la búsqueda en WordPress con SearchWP.

Una vez hecho esto, haz clic en “Guardar cambios” y pasa a la pestaña “Slugs”.

Configure the search options for the documentation

Aquí puede añadir slugs para los artículos, categorías y etiquetas de su documentación.

Después de elegir, haz clic en el botón “Guardar cambios” para establecer los ajustes.

Add slugs

Paso 4: Configurar la barra lateral y los ajustes de estilo de Knowledgebase

A continuación, pase a la pestaña “Barras laterales” para seleccionar la estructura / disposición / diseño / plantilla de las barras laterales de las páginas de documentación.

Puedes elegir diferentes posiciones para la barra lateral de inicio / página de inicio, la barra lateral de categorías y la barra lateral de artículos. Incluso puede marcar / comprobar la opción “Barra lateral de artículos fija” para activar una barra lateral fija para las páginas.

Una vez hecho esto, haz clic en “Guardar cambios” y pasa a la pestaña “Estilos”.

Configure sidebar settings

Desde aquí, puede seleccionar el ancho de la documentación, el color del enlace, el estilo de la cabecera y el color del texto a su gusto.

A continuación, basta con hacer clic en el botón “Guardar cambios”.

Customize knowledge base

Paso 5: Establecer los ajustes de respuesta / comentario / opinión y correo electrónico del artículo

A continuación, debe cambiar a la pestaña “Comentarios sobre el artículo” y comprobar la opción “Activar comentarios” para permitir que los usuarios valoren sus artículos.

Incluso puede añadir un sistema de upvote/downvote para su documentación de WordPress marcando esas casillas. De este modo, los usuarios podrán decirte si tu documentación les ayuda a resolver sus problemas en el front-end.

Ahora, haz clic en el botón “Guardar cambios” para establecer los ajustes.

Enable user feedback for documentation

Ahora, cambia a la pestaña ‘Informes por correo electrónico’ de la columna de la izquierda y comprueba la opción ‘Activar informes por correo electrónico’ si quieres que Heroic KB te envíe informes semanales sobre tu documentación.

Este informe incluirá el total de visitas y la valoración / puntuación media de sus artículos de documentación e incluso mostrará un listado de los artículos más vistos y mejor valorados de esa semana.

Una vez hecho esto, añada su dirección de correo electrónico de administrador al campo “Destinatarios del informe”. Si lo desea, puede añadir varias direcciones de correo electrónico.

A continuación, haz clic en el botón “Guardar cambios” para establecer los ajustes.

Enable email reports

Ahora que has establecido todos los ajustes para el plugin Heroic KB, es hora de empezar a crear la documentación para tu sitio web.

Paso 6: Crear documentación para su sitio WordPress

Puede crear artículos prácticos, bases de conocimientos, guías y preguntas frecuentes para su documentación.

Para empezar a crear un nuevo documento, visite la página Heroic KB ” Añadir nuevo artículo desde el escritorio de WordPress.

Esto abrirá el editor de contenido de WordPress, donde puede añadir un encabezado para su artículo de documentación y empezar a escribir el contenido. También puede hacer clic en el botón “+” de la esquina superior izquierda para añadir diferentes bloques a su contenido.

Add a new article for documentation

Una vez que haya escrito el artículo para la documentación, deberá desplegar la pestaña “Categorías” del panel de bloques y enlazar “Añadir nueva categoría de artículo”.

A continuación, cree una categoría para el artículo que está escribiendo.

Add new category for the documentation article

A continuación, amplíe la sección “Etiquetas” del panel de bloques y añada tantas etiquetas como desee para su artículo de documentación.

Incluso puede añadir un extracto del artículo desplegando la pestaña “Extracto”.

A continuación, despliegue la pestaña “Debate” y desactive la opción “Permitir comentarios” si desea desactivar los comentarios para este artículo. Si quieres permitir que los usuarios añadan comentarios, puedes dejar esta opción como está.

Add tags and excerpt for your article

También puede añadir archivos adjuntos a sus artículos en la documentación. Para ello, desplácese hasta la sección “Opciones del artículo” del editor de bloques y haga clic en el botón “Añadir o subir archivos”.

Se abrirá la biblioteca de medios, desde la que podrá añadir los archivos adjuntos que desee.

A continuación, marque la casilla “Archivos adjuntos en ventana nueva” si desea que los archivos adjuntos del artículo se abran en una ventana nueva al hacer clic en ellos.

Add attachments to the article

Si lo desea, también puede desactivar la característica de votar a favor o en contra de determinados artículos desplazándose hasta la sección “Opciones de votación”.

Aquí, marque la opción ‘Desactivar votación’ para desactivar el sistema de upvote/downvote para este artículo específico.

Disable voting for this specific article

Por último, haga clic en el botón “Publicar” de la parte superior para publicar su artículo como documentación.

Ahora, repita el proceso de nuevo para añadir múltiples entradas para su documentación bajo diferentes categorías.

Una vez hecho esto, puede ver fácilmente la documentación visitando la página www.example.com/knowledge-base, o puede visitar la página personalizada que haya elegido para su documentación.

Website documentation preview

Paso 7: Cambie el orden de los artículos y categorías de su documentación

Con Heroic KB, también puede cambiar el orden de los artículos mostrados en su base de conocimientos de WordPress. Para ello, visite la página de ordenación de artículos de Heroic KB desde el escritorio de WordPress.

Seleccione la categoría para la que desea cambiar el orden de los artículos. A continuación, simplemente arrastre y suelte los artículos para reordenarlos según sus preferencias.

Change the article order

Cuando haya terminado, no olvide hacer clic en el botón “Guardar pedido” para establecer los ajustes.

Para cambiar el orden de las categorías mostradas en su página de documentación, visite la página Heroic KB ” Ordenación de Categorías desde la barra lateral del administrador de WordPress.

Una vez allí, puede reorganizar el orden de las categorías arrastrándolas y soltándolas. Al hacer los cambios, haga clic en el botón “Guardar orden” para guardar sus ajustes.

Change the category order of the documentation

Ha creado correctamente la documentación de su sitio web y ha modificado su categoría y el orden de los artículos.

Bonificación: Añada una sección de FAQ a su sitio WordPress

Añadir documentación en WordPress es una buena forma de ayudar a tus usuarios a encontrar la información que necesitan. También puede añadir FAQs (preguntas más frecuentes) junto con las entradas de su blog para responder a las preguntas más frecuentes relacionadas con su contenido.

Esto puede aumentar la participación de los usuarios en tu blog de WordPress y generar confianza y credibilidad entre tus usuarios, haciéndoles saber que comprendes sus preguntas y preocupaciones.

Además, las FAQ pueden mejorar su posicionamiento SEO al permitirle utilizar palabras clave de cola larga que los usuarios suelen buscar en los motores de búsqueda.

Puede añadir fácilmente FAQ a su sitio web utilizando All in One SEO (AIOSEO). Es el mejor plugin SEO para WordPress del mercado que te permite optimizar fácilmente tu sitio web para mejorar el posicionamiento en los motores de búsqueda.

All in One SEO plugin

AIOSEO incluye incluso un bloque FAQ fácil de usar que puede añadirse directamente al editor de bloques, donde puede introducir preguntas y respuestas para su sección FAQ.

El plugin también le permite personalizar su sección FAQ desde el panel de bloques, incluyendo su color de texto, color de fondo, tipografía y envoltura del título, haciendo de AIOSEO el mejor plugin WordPress FAQ del mercado.

Add the AIOSEO FAQs block in your block editor

Además, el plugin incluye el marcado FAQ schema, que puede mejorar la clasificación de tu sitio web y la tasa de clics orgánicos haciendo que las preguntas más frecuentes aparezcan directamente en los resultados de búsqueda de Google.

Para obtener instrucciones más detalladas, consulte nuestro tutorial sobre cómo añadir una sección de preguntas frecuentes en WordPress.

Esperamos que este artículo te haya ayudado a aprender cómo añadir documentación en WordPress. También puedes consultar nuestra guía para principiantes sobre cómo crear un sitio de preguntas y respuestas en WordPress y nuestra selección de los mejores plugins de acordeón para usuarios de WordPress.

If you liked this article, then please subscribe to our YouTube Channel for WordPress video tutorials. You can also find us on Twitter and Facebook.

Descargo: Nuestro contenido está apoyado por los lectores. Esto significa que si hace clic en algunos de nuestros enlaces, podemos ganar una comisión. Vea cómo se financia WPBeginner , por qué es importante, y cómo puede apoyarnos. Aquí está nuestro proceso editorial .

Avatar

Editorial Staff at WPBeginner is a team of WordPress experts led by Syed Balkhi with over 16 years of experience in WordPress, Web Hosting, eCommerce, SEO, and Marketing. Started in 2009, WPBeginner is now the largest free WordPress resource site in the industry and is often referred to as the Wikipedia for WordPress.

El último kit de herramientas de WordPress

Obtenga acceso GRATUITO a nuestro kit de herramientas - una colección de productos y recursos relacionados con WordPress que todo profesional debería tener!

Reader Interactions

7 comentariosDeja una respuesta

  1. Syed Balkhi says

    Hey WPBeginner readers,
    Did you know you can win exciting prizes by commenting on WPBeginner?
    Every month, our top blog commenters will win HUGE rewards, including premium WordPress plugin licenses and cash prizes.
    You can get more details about the contest from here.
    Start sharing your thoughts below to stand a chance to win!

  2. Jiří Vaněk says

    That looks great. I have a tech blog, and while creating a glossary for it, I kept thinking about the best way to go about it. In the end, I created a page and organized blocks alphabetically. Then, using Elementor, I manually added links to individual glossary pages. After reading this article, I’ve been quite tempted to redo it into a much nicer and more professional format. Thanks!

  3. Ram E. says

    It would have been nice if the post also included a few other alternatives to the Heroic KB plugin, especially freemium ones. Anyway, the guide is still very helpful and it reminds me again why WordPress as a CMS is great–any feature one can think of, there’s a big chance a plugin already exists to do that!

Deja tu comentario

Gracias por elegir dejar un comentario. Tenga en cuenta que todos los comentarios son moderados de acuerdo con nuestros política de comentarios, y su dirección de correo electrónico NO será publicada. Por favor, NO utilice palabras clave en el campo de nombre. Tengamos una conversación personal y significativa.