Las 6 mejores herramientas de documentación: una lista seleccionada para 2022

¿Está buscando las mejores herramientas de documentación que lo ayuden a crear contenido de documentación interno o externo de primer nivel?

Ya sea que esté creando documentación pública para consumidores no técnicos o contenido técnico, como la documentación de la API de su software (o cualquier otra cosa), existen excelentes herramientas de documentación que lo ayudarán a administrar su contenido y publicarlo para los usuarios.

En esta publicación, hemos seleccionado una lista de las seis opciones principales, incluidas las soluciones de código abierto y SaaS para todos los presupuestos (incluidas las gratuitas).

Para las seis herramientas, destacaremos sus beneficios, desventajas, precios y cómo puede comenzar con su documentación usando esa herramienta.

¡Entremos de inmediato!

Las seis mejores herramientas de documentación

1. Base de conocimiento heroica
2. GitBook
3. Documento360
4. Leer los documentos
5. Noción + Engine.so
6. ayudajugo

1. Base de conocimiento heroica

Heroic Knowledge Base es una herramienta de documentación de código abierto que se basa en el popular software WordPress, que también es de código abierto.

Puede instalar Heroic Knowledge Base como un complemento en WordPress para convertir inmediatamente su sitio de WordPress en un centro de documentación.

La forma en que crea su sitio depende de usted: puede crear un nuevo sitio de WordPress que sea exclusivamente para documentación o puede instalar Heroic Knowledge Base en un sitio de WordPress existente para agregar funcionalidad de documentación a ese sitio.

Para crear contenido, puede usar el editor de bloques flexible de WordPress, junto con el sistema de revisión integrado de WordPress para el control de versiones.

Heroic Knowledge Base también agrega sus propios bloques dedicados para que pueda agregar fácilmente llamadas, advertencias y otros aspectos destacados.

También obtiene herramientas para hacer que parte o toda su documentación sea privada, dependiendo de si está creando documentación pública o interna.

Heroic Knowledge Base también le brinda toneladas de funciones para crear una gran experiencia para sus visitantes y optimizar su documentación:

• Búsqueda AJAX en tiempo real con sugerencias en vivo.
• Categorías y etiquetas para organizar los artículos.
• Análisis incorporado para rastrear búsquedas, vistas, efectividad de artículos y transferencias a canales de soporte en vivo.

Debido a que está basado en WordPress, también puede ampliar su documentación utilizando otros complementos. Por ejemplo, puede usar el complemento gratuito Multicollab para agregar comentarios y colaboración al estilo de Google Docs al editor de contenido.

Beneficios

• Usuarios ilimitados, artículos, categorías, etc. Básicamente, no hay límites arbitrarios como los que normalmente encuentra en las herramientas de documentación de SaaS.
• flexibles Heroic Knowledge Base incluye toneladas de funciones integradas para ayudarlo a configurar su documentación y también puede instalar otros complementos de WordPress según sea necesario, como agregar funciones de colaboración.
• Propiedad total de los datos . Todos sus datos permanecen 100% en sus propios servidores en todo momento.
• Código abierto . Tanto WordPress como Heroic Knowledge Base son de código abierto.

Desventajas

• Si no desea utilizar WordPress por alguna razón, es importante tener en cuenta que Heroic Knowledge Base solo funciona con WordPress.

Precios

Heroic Knowledge Base comienza en $ 149 para usar en un solo sitio web y un año de soporte y actualizaciones. Conservará el acceso al software para siempre sin costo adicional, pero deberá renovar su licencia para continuar recibiendo soporte y actualizaciones después del primer año.

También necesitará un sitio web de WordPress, que puede costar algo de dinero si aún no tiene acceso a un alojamiento de sitios web que sea capaz de ejecutar WordPress.

Cómo empezar

A continuación se explica cómo configurar un centro de documentación utilizando Heroic Knowledge Base:

1. Cree un sitio de WordPress para que actúe como la base de su centro (si aún no lo ha hecho).
2. Compre e instale el complemento Heroic Knowledge Base.
3. Configure el comportamiento de su centro de documentación usando la configuración ( Heroic KB → Configuración )
4. Agrega artículos usando el editor de bloques flexible.

También puede agregar otros ajustes, como crear un sitio de intranet, restringir el acceso a los usuarios registrados o solicitar una contraseña para ver la documentación (que puede ser útil para la documentación interna).

2. GitBook

Como sugiere el nombre, GitBook es una herramienta de documentación que está más orientada a los equipos de software que necesitan crear documentación pública o privada.

Por ejemplo, puede sincronizar GitBook con un repositorio de GitHub o GitLab que contiene archivos de descuento para crear su documentación de esa manera. Sin embargo, no está obligado a usar Git solo para usar GitBook y también puede crear contenido usando un editor intuitivo o importarlo desde otras fuentes, como archivos Markdown, documentos de Word y más.

Para organizar su documentación, puede utilizar "espacios" (es decir, una base de conocimiento única) y "colecciones" (es decir, una categoría dentro de una base de conocimiento).

Algunas otras características notables incluyen las siguientes:

• Control de versiones.
• Edición y colaboración en equipo en vivo.
• Incrustaciones enriquecidas en el editor de contenido.
• Fácil exportación de PDF.

Beneficios

• Utilice flujos de trabajo técnicos familiares . Para los equipos técnicos, GitBook les permite usar herramientas con las que ya están familiarizados (como Git). También utiliza términos técnicos, como "sucursales" y "solicitudes de cambio" para las ediciones.
• Funciones de colaboración . Esto puede ser útil si varias personas trabajan en el mismo documento (tal vez incluso al mismo tiempo).
• Gratis para organizaciones sin fines de lucro. Si es una organización sin fines de lucro o ejecuta un proyecto de código abierto, puede usar GitBook de forma gratuita.

Desventajas

• tecnico Si no está creando documentación de software, GitBook puede parecer un poco complejo. Las personas que buscan crear documentación no técnica probablemente querrán buscar en otra parte.

Precios

GitBook es gratuito para uso individual, sin fines de lucro y proyectos de código abierto. Los planes comerciales comienzan en $8 por usuario por mes, con un mínimo de 5 usuarios. Entonces, el plan más barato sería de $ 40 por mes.

Cómo comenzar con Heroic Knowledge Base

Para comenzar, solo necesita registrarse para obtener una cuenta de GitBook y comenzar a construir. Puede sincronizar con un repositorio en GitHub o crear desde cero utilizando los editores de contenido de GitBook.

3. Documento360

Document360 es una herramienta de documentación de SaaS que le permite crear su propia base de conocimiento interna o orientada al futuro.

Debido a su enfoque SaaS, es muy fácil comenzar. Simplemente regístrese para obtener una cuenta y comience a crear su documentación a través de la interfaz fácil de usar.

Puede crear contenido usando un editor WYSIWYG simple con soporte Markdown. También obtendrá acceso a herramientas de colaboración y control de versiones, lo cual es útil si está trabajando con un equipo.

En la interfaz, sus usuarios obtendrán una interfaz bien diseñada para buscar contenido, incluidos toques útiles como sugerencias de búsqueda en vivo, tabla de contenido automática y más.

Beneficios

• Fácil configuración . Para crear documentación, solo necesita registrarse para obtener una cuenta y comenzar a escribir.
• Alojado para usted . Document360 maneja el alojamiento y el mantenimiento de su documentación por usted, por lo que nunca tendrá que preocuparse por las actualizaciones ni nada por el estilo.
• Funciones de productividad . Obtiene acceso a algunas características interesantes, como recordatorios de revisión automáticos, notificaciones para eventos de la base de conocimientos y más.

Desventajas

• Caro. El plan pagado más barato ya cuesta $ 119 por mes y solo incluye funciones limitadas.
• Limitaciones . Si necesita más cuentas de equipo o bases de conocimiento, deberá pagar más. Por ejemplo, el plan Startup solo incluye cinco cuentas de equipo. Si quiere más que eso, pagará $19 por mes por cuenta.

Precios

Document360 es una herramienta SaaS, por lo que pagará una tarifa mensual o anual durante el tiempo que desee utilizarla. Los planes comienzan en $119 por proyecto por mes, más $39 por versión adicional de la base de conocimientos y $19 por cada cuenta de equipo más allá de las cinco cuentas incluidas.

También hay un plan gratuito que le permite crear hasta 50 artículos con 1 GB de almacenamiento y acceso limitado a funciones.

Cómo comenzar con Document360

Document360 es una herramienta de documentación SaaS, lo que significa que todo lo que necesita hacer es registrarse para obtener una cuenta para comenzar.

Hay una prueba gratuita de 14 días para que pueda explorar todas las funciones de forma gratuita.

4. Lea los documentos

Read the Docs es una herramienta de documentación creada específicamente para software o documentación técnica.

Le permite administrar su contenido y control de versiones usando Git y luego implementarlo fácilmente en una interfaz de usuario fácil de usar. Este enfoque significa que solo es realmente accesible para los desarrolladores... pero eso tiene sentido dado que se centra en la creación de documentación técnica.

Dependiendo de la versión que esté utilizando, también puede obtener acceso a algunas o todas las siguientes funciones:

• Análisis para ver qué buscan y leen los visitantes.
• Resultados de búsqueda en vivo y sugerencias.
• Múltiples compilaciones simultáneas. Por ejemplo, una compilación para producción y otra para beta o una para la versión 1.0 y otra para la versión 2.0.
• Fácil exportación a PDF, HTML o epub.
• Inicio de sesión único a través de Google Workspace o proveedor de VCS (GitHub, GitLab o Bitbucket).

Beneficios

• Utilizar herramientas de desarrollo . Al usar herramientas como Git para administrar la documentación, Read the Docs intenta integrarse en los flujos de trabajo existentes de los desarrolladores de software.
• Versión fuerte . Git facilita la administración de versiones y también puede publicar varias versiones de sus documentos al mismo tiempo, lo cual es excelente si las personas pueden estar usando diferentes versiones de su software.

Desventajas

• Configuración más compleja . Read the Docs es un poco más complejo de configurar que otras herramientas de documentación porque necesita trabajar a través de Git. Sin embargo, dado que se centra en la documentación técnica, los tipos de personas que utilizan Read the Docs no deberían tener problemas.
• Sólo para documentación técnica . Si no está creando documentación de software/técnica, querrá elegir una herramienta de documentación diferente, ya que Read the Docs no es para usted.

Precios

Si tiene un proyecto de código abierto, Read the Docs le permite crear y alojar su documentación de forma gratuita. De hecho, Read the Docs dice que alberga documentación gratuita para más de 240.000 proyectos de código abierto.

Para las empresas comerciales, también hay un servicio de pago Read the Docs for Business, que comienza en $ 50 por mes. Todos los planes incluyen proyectos y usuarios ilimitados: las principales limitaciones son las funciones que obtiene y la cantidad de compilaciones simultáneas que puede tener.

Cómo empezar a leer los documentos

Read the Docs le brinda dos formas de escribir su documentación real:

1. MkDocs
2. Esfinge

Una vez que use esas herramientas para crear un repositorio Git con el contenido de su documentación, Read the Docs importará automáticamente el repositorio para crear su documentación.

5. Noción + Engine.so

La noción es un poco complicada aquí, ya que no está diseñada específicamente para la documentación. Sin embargo, con la configuración adecuada, puede ser una gran herramienta para manejar todo tipo de documentación.

Si no está familiarizado con Notion, es básicamente una herramienta todo en uno para manejar cualquier tipo de conocimiento, datos, gestión de proyectos y mucho más.

Puede usarlo para muchas cosas diferentes, incluida la creación de todo tipo de documentación. Sin embargo, la desventaja es que Notion en sí mismo no se enfoca realmente en publicar esa información en un sitio web donde otras personas puedan interactuar con ella.

Ahí es donde entra en juego Engine.so. Con Engine.so ( un servicio de terceros ), puede publicar su contenido de Notion en su propio sitio web para crear fácilmente su propio centro de documentación. Puede ver un ejemplo de cómo se ve esto en la documentación de Engine.so.

Beneficios

• Maneras únicas de presentar la información . El uso de Notion le brinda mucha flexibilidad que quizás no obtenga con herramientas de documentación más específicas. Por ejemplo, puede usar los muchos bloques Notion de formas interesantes.
• Fácil de usar A diferencia de las herramientas basadas en Git, este enfoque es fácil tanto para usuarios técnicos como no técnicos.
• Asequible . Si bien no hay un plan gratuito, este enfoque debería ser asequible para la mayoría de los casos de uso.

Desventajas

• No está diseñado específicamente para la documentación . Si bien Notion funciona muy bien para la documentación, ese no es el único enfoque, como lo es con las otras herramientas de documentación en esta lista. Si planea tener cientos de artículos, es posible que prefiera una herramienta más específica.
• Control de versiones limitado. Este enfoque no ofrece un fuerte control de versiones. Si paga por Notion, puede obtener un historial de versiones de 30 días, pero no es tan sólido como Git o el sistema de WordPress que obtiene con Heroic Knowledge Base.

Precios

Notion tiene un plan gratuito que debería funcionar bien para casos de uso básicos. Sin embargo, existe la posibilidad de que desee pagar según sus necesidades específicas.

Sin embargo, para convertir su contenido de Notion en un centro de documentación pública, deberá pagar Engine.so. Engine.so cuesta $ 19 por mes por hasta 300 páginas o $ 49 por mes por hasta 1,000 páginas. Puede probarlo con una prueba gratuita de 14 días.

Cómo empezar con Notion

Aquí se explica cómo crear documentación usando esta configuración:

1. Regístrese para obtener una cuenta de Notion.
2. Crea tu documentación usando Notion. Puede encontrar plantillas de Notion prefabricadas para el contenido de la documentación, como estas plantillas de Beestat.
3. Regístrese para obtener una cuenta de Engine.so.
4. Publique su documentación de Notion en su propio sitio web personalizado/centro de documentación usando Engine.so.

6. Jugo de ayuda

Al igual que Document360, Helpjuice es otra base de conocimiento y herramienta de documentación SaaS popular.

Le ayuda a crear fácilmente cualquier tipo de documentación utilizando un editor de texto simple, que incluye opciones para importar desde documentos de Word para ahorrar tiempo.

También obtiene acceso a un montón de características para crear documentación efectiva:

• Resultados de búsqueda instantáneos/sugerencias.
• Análisis para rastrear búsquedas, páginas vistas y mucho más.
• Opción de publicar múltiples versiones de su documentación.
• Niveles de acceso de usuarios para controlar quién puede ver los diferentes artículos.
• Funciones de colaboración que incluyen comentarios en el editor.

Beneficios

• Fácil configuración . Para crear documentación, solo necesita registrarse para obtener una cuenta.
• Alojado para usted . Helpjuice maneja el alojamiento y el mantenimiento de su documentación por usted, por lo que nunca tendrá que meterse con las actualizaciones ni nada.
• No hay planes bloqueados por funciones . Si bien Helpjuice no tiene un plan gratuito, todos sus planes pagos le brindan acceso a todas las funciones.

Desventajas

• caro El plan más barato comienza en $ 120 por mes y puede llegar hasta $ 500 por mes.
• Límites de usuarios . Si tiene un equipo grande, Helpjuice puede resultar costoso. Por ejemplo, si tiene más de 60 usuarios, necesita el plan de $500 por mes.

Precios

Los planes pagos de Helpjuice comienzan en $120 por mes para todas las funciones y hasta cuatro usuarios. Los planes aumentan a partir de ahí según la cantidad de usuarios que necesita, con un máximo de $ 500 por mes para usuarios ilimitados.

Lo único es que obtiene acceso a todas las funciones en todos los planes, mientras que algo como Document360 bloquea ciertas funciones detrás de los planes de nivel superior.

También puede probar todo con una prueba gratuita de 14 días.

Cómo comenzar con Helpjuice

Para comenzar, todo lo que necesita hacer es registrarse para obtener una cuenta de Helpjuice y comenzar a agregar su contenido.

¿Cuál es la mejor herramienta de documentación para sus necesidades?

Al final, elegir la mejor herramienta de documentación realmente depende de sus necesidades específicas, presupuesto y nivel de conocimiento.

Aquí hay algunas preguntas comunes que querrás hacerte para acotar tu búsqueda:

• ¿Quiere una solución autohospedada o está de acuerdo con usar una herramienta SaaS?
• Del mismo modo, ¿quieres una solución de código abierto o estás de acuerdo con usar una herramienta de código cerrado?
• ¿Está creando documentación muy técnica (por ejemplo, documentación API) o más documentación orientada al consumidor?
• ¿Le gusta la idea de usar Git para el control de versiones/gestión de contenido o prefiere tener un sistema de gestión del conocimiento dedicado?
• ¿Cuál es tu presupuesto? ¿Está de acuerdo con pagar una tarifa mensual continua o quiere algo que sea gratis o un pago único?

Al responder esas preguntas, debería tener una buena idea de cuál es la mejor herramienta de documentación para sus necesidades.

Si no está seguro de por dónde empezar, creemos que Heroic Knowledge Base puede satisfacer las necesidades de la mayoría de las empresas. Ofrece un enfoque rentable y de código abierto que le brinda la propiedad total de sus datos a un precio más bajo que la mayoría de las otras herramientas.

Pero al mismo tiempo, todavía tiene acceso a toneladas de funciones para crear documentación de primer nivel, como sugerencias de búsqueda en vivo y análisis detallados. También obtiene acceso a todo el ecosistema de WordPress si desea aún más flexibilidad.

Para obtener más información y comenzar, diríjase a la página del producto Base de conocimiento heroico.