Documentación externa: cómo publicar y compartir tus docs

Has pasado semanas creando y organizando la documentación interna de tu empresa. Ahora necesitas compartir parte de ella con clientes, partners y contratistas.

Pero te quedas con tres opciones poco ideales:

1. Exportar los documentos como PDF. Sin embargo, cuando las instrucciones cambian, tienes que enviar archivos nuevos mientras las copias antiguas siguen circulando.
2. Crear una base de conocimientos separada para usuarios externos. El problema es que los cambios en tus guías internas tienen que trasladarse a sus copias externas. Si se te escapa una actualización, los lectores pueden acabar siguiendo instrucciones que tu equipo ya ha reemplazado.
3. Dar a los usuarios externos acceso a tu base de conocimientos interna. Pero sin permisos bien delimitados, un contratista que trabaja en un proyecto podría ver información confidencial o documentos destinados a otro.

Pero hay una cuarta forma, y mejor, de crear documentación externa: publicar páginas seleccionadas de tu base de conocimientos existente mientras los documentos internos siguen siendo privados.

Veremos qué publicar, cómo gestionar el acceso para distintas audiencias y cómo mantener actualizada tu documentación externa.

Puntos clave

• La documentación externa debería exponer solo las partes de tu conocimiento existente que clientes, partners o contratistas necesitan.
• Las páginas públicas son adecuadas para guías de utilidad general, pero desactivar la indexación en motores de búsqueda no restringe quién puede abrir un enlace público.
• Los contratistas y partners deberían tener acceso solo a los documentos o canales necesarios para su trabajo, con permisos de edición concedidos por separado.
• Publicar desde un documento mantenido alinea las instrucciones externas con las actualizaciones que hace tu equipo interno.
• Antes de compartir un documento, revisa los archivos enlazados, las páginas anidadas, los ajustes de búsqueda y lo que un lector sin sesión iniciada puede abrir realmente.
• Usa software específico cuando tu documentación externa necesite flujos de tickets de soporte, referencias de API versionadas o pruebas interactivas de API.

¿Qué es la documentación externa?

La documentación externa (o documentación de cara al exterior) se refiere a todo lo que una empresa pone a disposición de personas ajenas a su organización, desde guías hasta instrucciones y materiales de referencia, incluidos prospectos, clientes, partners y contratistas.

Favorece el autoservicio: los lectores pueden evaluar un producto, completar tareas o seguir procedimientos sin contactar con el personal para cada respuesta.

Algunos ejemplos habituales:

• Guías de onboarding de clientes e instrucciones de resolución de problemas que ayudan a la gente a empezar y a resolver incidencias.
• Manuales de producto y documentación de usuario que explican funciones, ajustes y flujos de trabajo.
• Referencias de API y guías de integración que los desarrolladores pueden usar para evaluar o conectar un producto.
• Recursos para partners y contratistas que explican cómo realizar el trabajo con tu empresa.

Cómo publicar documentación externa

Una guía de producto pensada para clientes, por ejemplo, puede necesitar ajustes de compartición distintos de los de un brief de proyecto pensado para un contratista.

Antes de publicar nada, tienes que establecer qué debería poder ver cada audiencia.

Decide qué debe ser público y qué debe quedarse interno

Repasa tus documentos existentes e identifica las instrucciones que un lector externo realmente necesita. Un cliente que configura una cuenta necesita los pasos y las capturas de pantalla de esa tarea, pero no tu proceso de escalado, tus notas privadas de la cuenta ni tus planes para funciones no lanzadas, aunque todos esos detalles estén en la misma guía interna.

Mientras revisas el material, clasifícalo en tres grupos:

• Público: instrucciones de productos ya lanzados, guías generales de resolución de problemas y requisitos de integración públicos que no contienen información restringida.
• Interno (requiere revisión): documentación de procesos internos que mezcla pasos de cara al cliente con notas solo para empleados. Elimina la información interna o prepara una versión pública separada y aprobada.
• Confidencial o restringido: credenciales, datos identificables de clientes, condiciones comerciales confidenciales, funciones no lanzadas y decisiones internas que los lectores externos a la empresa no están autorizados a ver.

Revisa también capturas de pantalla, archivos adjuntos, enlaces y subdocumentos. Una página puede no contener texto confidencial y aun así enlazar a un archivo que nunca estuvo pensado para lectores externos.

Asigna a cada audiencia el nivel de acceso adecuado

Una vez decidido qué se puede compartir, elige quién debería poder abrir cada documento.

¿Necesita acceso cualquiera que tenga el enlace, o los lectores deberían iniciar sesión? ¿Solo leen instrucciones, o necesitan comentar o editar? Esas respuestas determinarán qué opción de compartición usar.

En este punto también puedes aplicar el principio de mínimo privilegio: en Slite, por ejemplo, puedes dar a contratistas y partners acceso solo a los documentos que necesitan, y asignar permisos de Editor solo cuando necesiten editar. Revoca el acceso cuando un proyecto termine o cambien las responsabilidades. Revisa periódicamente los enlaces públicos y quién está autorizado a publicarlos.

Publica desde una única fuente para que la versión externa se mantenga al día

Cuando tu equipo actualiza las instrucciones de configuración de la cuenta, esos cambios también deberían aparecer en la documentación que ven los clientes. De lo contrario, los clientes pueden seguir siguiendo pasos obsoletos en un PDF o en un artículo del centro de ayuda.

Para evitarlo, publica directamente desde el documento que mantiene tu equipo y comparte un enlace vivo con los clientes. Así, las actualizaciones del documento original se reflejan en la versión publicada sin tener que actualizar varias copias.

Por ejemplo, en Slite puedes hacerlo con la opción Share to web. Cuando actualizas el documento original, la página publicada refleja esos cambios, así que los clientes que abren el enlace ven las instrucciones más recientes. Sin embargo, los PDF o capturas de pantalla que hayan guardado no se actualizarán automáticamente.

Usamos el mismo enfoque para el centro de ayuda de Slite. Nuestro equipo escribe y mantiene los artículos de ayuda en Slite y luego los publica en nuestro sitio web.

Las ediciones en el documento original pueden hacerse visibles en la página pública de inmediato. Para cambios de alto impacto, te recomendamos usar un proceso de revisión:

• Prepara las instrucciones revisadas en un borrador privado si los cambios afectan a la seguridad, la facturación, la configuración de la cuenta u otro flujo de alto impacto.
• Haz que el propietario del documento correspondiente revise y apruebe los cambios antes de actualizar el documento compartido públicamente.
• Revisa los documentos que cambian con frecuencia según un calendario, incluso cuando nadie haya reportado un error.

Para el mantenimiento continuo, Slite Agent puede ayudar a tu equipo a identificar información obsoleta contrastando la documentación con las fuentes conectadas y señalando posibles inexactitudes. Los propietarios de los documentos pueden revisar sus hallazgos y aprobar los cambios sugeridos antes de actualizar las instrucciones publicadas.

Configura y revisa el acceso externo

Una vez decidido qué publicar y quién debería verlo, configura los ajustes de compartición en tu plataforma de documentación. Según la herramienta, podrás compartir un enlace público o invitar a personas concretas, con controles separados para la edición, las páginas anidadas y la visibilidad en buscadores. Para un sitio de documentación externa con tu marca, comprueba también si la plataforma admite un dominio personalizado y la personalización del espacio de trabajo.

Por ejemplo, en Slite, abre el documento y selecciona Share. Puedes invitar a clientes, partners o contratistas concretos a colaborar, o usar Share to web para publicarlo de forma pública. Si eliges la opción pública, comprueba estos ajustes antes de copiar el enlace:

• Quién puede acceder: en Anyone with the link, elige si los visitantes pueden ver o editar la página. El acceso de solo lectura suele ser lo adecuado para instrucciones publicadas. Desactivar la indexación en motores de búsqueda no hace que el enlace sea privado, así que usa invitaciones cuando el acceso deba restringirse.
• Qué más se incluye: revisa Include sub-docs, ya que activarlo también hace accesibles las páginas anidadas a través de la página pública. Revisa esas páginas antes de activarlo.
• Cómo encuentran respuestas los visitantes: activa Search engine indexing si quieres que los motores de búsqueda descubran la página. También puedes activar la búsqueda con IA (Ask) para que los visitantes hagan preguntas sobre la documentación publicada sin acceder a los documentos privados del espacio de trabajo.
• Si los visitantes pueden duplicar la página: Show duplication button controla si los visitantes pueden copiar el documento a su propia cuenta de Slite.

Antes de compartir el documento, comprueba la experiencia desde fuera de tu espacio de trabajo. Para una página pública, abre el enlace en una ventana del navegador sin sesión iniciada; para colaboradores invitados, confirma a qué puede acceder su cuenta:

• Léelo como un visitante externo: asegúrate de que las instrucciones tienen sentido sin acceso a tu espacio de trabajo interno, y prueba los enlaces a archivos adjuntos y páginas relacionadas.
• Comprueba qué es accesible: confirma que solo están disponibles los subdocumentos y archivos aprobados, y que los lectores no son dirigidos a material interno que no pueden abrir.
• Prueba las funciones opcionales: si Ask público está activado, prueba una pregunta típica de cliente y comprueba la respuesta. Confirma también que el botón de duplicación aparece o se mantiene oculto según lo previsto.

Repite estas comprobaciones cuando cambien los permisos, añadas subdocumentos o hagas actualizaciones importantes en las instrucciones públicas. En Slite, los administradores del espacio de trabajo también pueden auditar qué páginas se comparten públicamente y quién tiene permiso para publicarlas.

¿Cuándo necesitas software especializado de documentación externa?

Para la mayoría de guías de clientes y recursos para partners, tu base de conocimientos existente puede ser suficiente. Pero según lo que publiques y cómo necesiten usarlo los lectores, puedes necesitar herramientas adicionales. Entre ellas:

Software de help desk

A veces, un cliente puede seguir una guía de resolución de problemas y aun así no poder resolver el problema. Necesita enviar un ticket de soporte y hablar con un agente.

Normalmente, el software de help desk gestiona la recepción, el enrutamiento y el escalado de tickets. Algunas herramientas también permiten desviar tickets sugiriendo artículos útiles antes de que el cliente envíe una solicitud.

Por ejemplo, Zendesk puede sugerir artículos relevantes de una base de conocimientos de atención al cliente antes de que alguien envíe un ticket, mientras que Intercom puede recoger valoraciones de los artículos para ayudar a tu equipo a identificar instrucciones que no resuelven las dudas de los lectores.

Con Slite, tu base de conocimientos interna también puede apoyar ese flujo de trabajo. Si tu equipo usa Intercom o Zendesk, la extensión de Chrome de Slite Agent permite a los agentes de soporte acceder al conocimiento interno relevante mientras gestionan las solicitudes de los clientes. Usa el contexto de la conversación o del ticket junto con las fuentes de conocimiento conectadas para sugerir una respuesta que los agentes pueden revisar antes de enviarla.

Software de documentación de API versionada

Las empresas de software suelen dar soporte a varias versiones de API a la vez porque no todos los clientes pueden migrar en cuanto se lanza una versión nueva. Alguien que todavía usa una versión antigua necesita instrucciones que coincidan con su integración, incluso después de que se publique la última versión.

El software especializado de documentación de API puede ayudar a los equipos con:

• Referencias versionadas: mantener documentación para las distintas versiones de API soportadas.
• Documentación generada desde OpenAPI: generar referencias de API a partir de especificaciones y mantenerlas alineadas con los cambios de la API.
• Entornos interactivos de API: permitir a los desarrolladores probar solicitudes e inspeccionar respuestas directamente desde la documentación.

Por ejemplo, en Slite usamos Mintlify para nuestra referencia de API porque está construido para documentación versionada orientada a desarrolladores.

Portales de documentación para clientes y partners

Si tu empresa trabaja con decenas de clientes o partners, cada uno con sus propias guías de onboarding, instrucciones de implementación y documentación de proyecto, gestionar el acceso mediante invitaciones individuales acabará siendo difícil a medida que se incorporen más organizaciones y usuarios.

Un portal de documentación específico para clientes o partners te ayuda a gestionar el acceso a escala mediante inicio de sesión único, permisos por grupos y controles que determinan qué recursos puede ver cada organización. Cada cliente o partner puede acceder así a la documentación pensada para él sin ver la información de otra organización.

Convierte la documentación externa en una extensión de tu base de conocimientos

Puedes compartir documentación útil sin crear otro conjunto de archivos que tu equipo tenga que actualizar cada vez que cambia un producto o un proceso. Empieza por el conocimiento que ya mantienes y luego elige qué información debería poder ver cada audiencia.

Con Slite, puedes:

• Publicar en la web documentos seleccionados del espacio de trabajo, con controles separados para la indexación en buscadores, los subdocumentos incluidos y la duplicación.
• Invitar a clientes, partners o contratistas a documentos o canales concretos, con permisos de Lector o Editor.
• Mantener a los lectores externos en la versión actual a medida que tu equipo actualiza un documento compartido, sin distribuir un archivo nuevo cada vez.
• Asignar propietarios de documentos, programar verificaciones y usar Slite Agent para investigar información obsoleta o contradictoria para su revisión humana.
• Ofrecer búsqueda con IA sobre el contenido que decidas publicar para lectores externos.

Si tienes previsto compartir guías de producto, materiales de onboarding o documentación para partners, reserva una demo. Te enseñaremos cómo publicar los documentos adecuados, gestionar el acceso externo y mantener la información al día.

Preguntas frecuentes

¿Qué significa "de cara al público" en documentación?

La documentación externa, o de cara al público, es la información que se pone a disposición de personas ajenas a una organización. Puede estar abierta a cualquiera o compartirse solo con lectores externos concretos.

¿Qué son los documentos de cara al cliente?

Los documentos de cara al cliente incluyen guías de onboarding, instrucciones de producto, referencias de integración, FAQ y artículos de resolución de problemas que ayudan a los clientes a evaluar, configurar y usar un producto.

¿Las páginas de documentación externa necesitan un dominio personalizado?

No. Los documentos públicos pueden usar la URL por defecto que proporciona la plataforma de documentación. Un dominio personalizado es opcional, y Slite lo admite en los planes elegibles, junto con opciones de personalización de marca para las páginas públicas.

¿Pueden las herramientas de IA y los motores de búsqueda usar la documentación externa?

Es posible, según los ajustes públicos del documento y el comportamiento de cada rastreador o herramienta. Slite tiene controles separados para la indexación en motores de búsqueda y la búsqueda con IA en documentos públicos. Sus respuestas públicas de IA usan el contenido publicado para lectores externos.