Documentación Digital: Mejores Prácticas para Informar e Inspirar
Product Documentation Best Practices

Digital Documentation: Best Practices to Inform and Inspire

Tal F

Tal F

May 04, 2021

Para impulsar la facilidad y consistencia, las empresas deben seguir las mejores prácticas de documentación digital. Esto abarca el diseño, el formato, la elección de tipos de archivo y la gobernanza de la documentación digital.


Share this article:

Del papel a los píxeles

Hace apenas unas décadas, casi todas las empresas usaban papel para su documentación. Contratos, políticas, notas de reuniones; todo era en papel - se imprimía y circulaba en lugar de adjuntarse y analizarse por correo electrónico.

Con el avance de la tecnología, las empresas obtuvieron más espacio de almacenamiento y sistemas informáticos para que los empleados accedieran a documentos digitales. Esto marcó el inicio de la transición del papel a los píxeles.

El mundo moderno de la documentación digital ofrece numerosos beneficios, pero persisten ciertos problemas. La documentación sirve para transmitir información, tanto a personal interno como a clientes externos. Por eso, la consistencia del contenido, la facilidad de acceso y de gestión son esenciales. Por el contrario, una documentación digital inconsistente, inaccesible y difícil de gestionar puede reducir la capacidad de tu empresa para comunicar información eficazmente.

Para lograr facilidad y consistencia, las empresas deben seguir las mejores prácticas de documentación digital. Esto incluye el diseño, el formato, la elección de tipos de archivo y la gobernanza de la documentación digital.

En este eBook, analizaremos las mejores prácticas para la documentación digital y el posible impacto empresarial de implementar estos cambios. ¿Puede una mejor documentación digital impulsar el crecimiento de ingresos y atraer clientes? ¿Cómo pueden las empresas transformar su documentación digital para ofrecer mayor valor a los clientes mediante un sistema de gestión documental o DMS?

¡Respondamos a estas preguntas!

Beneficios de la documentación digital

Antes de analizar el qué y el cómo de las mejores prácticas de documentación digital, debemos entender sus beneficios:

  • Facilidad de gestión -- La documentación digital es más fácil de gestionar que los documentos en papel. La documentación física requiere espacio en la oficina para archivadores y un archivo manual para cada documento. El almacenamiento digital libera espacio en la oficina y simplifica la gestión con funciones de búsqueda y estructuras de carpetas.

Según un estudio de Software Advice, los trabajadores de oficina dedican un promedio de seis horas semanales buscando documentos en papel. Además, emplean unas ocho horas semanales creando informes a partir de documentos en papel, y el 94% afirma que un sistema de gestión documental (DMS) facilita este proceso.[1]

  • Facilidad de acceso - Los documentos digitales pueden compartirse prácticamente en tiempo real mediante correo electrónico o almacenamiento en la nube. Esto elimina la necesidad de enviar cartas, ahorrando costes de envío postal o mensajería. También aumenta la velocidad de respuesta, ya que los destinatarios no tienen que esperar días para recibir una carta. Además, la documentación digital puede publicarse en tu sitio web o redes sociales, mejorando el acceso para los clientes.

¿Sabías que, según Gartner, por cada 1€ gastado en imprimir documentos, se gastan otros 6€ en manipularlos y distribuirlos? Además, la mitad de todos los documentos impresos se desechan en menos de 24 horas.[2]

  • Seguridad y gobernanza -- A menos que esté bajo llave, la documentación en papel es insegura. Cualquiera puede leerla, hacer una copia y compartirla. En cambio, la documentación digital puede protegerse mediante controles de acceso basados en roles (RBAC) para conceder acceso solo a quienes lo necesitan.

Ni siquiera los gobiernos son inmunes a las filtraciones de datos en papel: el Departamento de Asuntos de Veteranos de EE.UU. atribuye a la documentación en papel el 98% de sus violaciones de datos[3].

  • Beneficios medioambientales -- Tanto personas como empresas buscan formas de reducir su huella ambiental. La documentación digital es una vía para lograrlo. Según Green America, el consumo de papel ha aumentado un 400% en los últimos 40 años, y la industria representa el 4% del consumo energético mundial[4]. Al optar por la documentación digital, las empresas pueden reducir su uso de papel para combatir la deforestación, manteniendo vivos los árboles para absorber emisiones de carbono y sostener hábitats animales.

Mejores prácticas con documentación digital en Docsie

La documentación digital tiene el potencial de transformar la compartición de conocimientos, la publicación y el marketing en toda la empresa. Para aprovechar este potencial, las empresas deben seguir estas mejores prácticas:

Alinea tu DMS con las necesidades de negocio

Un sistema de gestión documental (DMS) es la base que ayuda a las empresas a almacenar y gestionar su documentación. Una vez creado el contenido, se sube a un DMS para su almacenamiento y distribución. Un DMS centraliza el almacenamiento documental, proporcionando una única fuente de conocimiento para toda la empresa. Funciona como una biblioteca digital, categorizando documentos por departamento o producto, con funcionalidad de búsqueda para agilizar la compartición de conocimientos. Desde aquí, los equipos de marketing y soporte pueden compartir documentación, publicándola en sitios web y redes sociales, o en respuesta a consultas de clientes.

Docsie es un DMS que simplifica la forma en que tu equipo gestiona documentos. Cada empresa necesita una forma de almacenar y compartir documentación, tanto para que el personal interno aprenda sobre su rol, como para que los clientes aprendan a usar tu producto o servicio. Documentos de incorporación de RRHH, guías de productos, plantillas de comunicación comercial... todos estos elementos pueden almacenarse y publicarse con la solución DMS adecuada.

¿Qué documentación existe actualmente sobre tus productos y servicios? ¿Tu personal utiliza plantillas y marcos cuando se comunica con los clientes? ¿Puedes almacenar, compartir internamente y publicar externamente tu documentación con facilidad? Hazte estas preguntas al considerar una solución DMS como Docsie, y asegúrate de que tu DMS esté alineado con las necesidades empresariales.

Céntrate en la compatibilidad

La documentación digital puede aumentar la accesibilidad, pero solo cuando se utilizan formatos de archivo altamente compatibles. Esto es importante con la documentación descargable, ya que algunos clientes podrían no poder abrir un archivo. También se aplica a la documentación interna, donde un empleado que use PDF y otro que use DOCX puede causar fragmentación de formatos, obligando a otros empleados a cambiar de paquetes de software o convertir a otro formato para hacer accesible el archivo.

Los formatos de archivo abiertos como docx, xlsx y pptx para Microsoft Office, o el formato de documento abierto (ODF) para OpenOffice son ideales para maximizar la compatibilidad. Los documentos PDF de Adobe son comunes, pero menos compatibles porque requieren un visor de PDF. Considera quién accederá a estos documentos y almacena la documentación en un formato que satisfaga a la base de usuarios más amplia posible.

Docsie es una gran opción para una amplia compatibilidad documental. Cuando el texto se carga en el Editor de Libros de Docsie, se almacena en el formato de archivo JavaScript Object Notation (JSON) de código abierto. Puedes encontrar más información sobre la exportación de documentos y cómo Docsie permite una fácil conversión a formatos DOC, PDF, Markdown (MD) y HTML aquí.

Retroalimentación accionable

La retroalimentación de usuarios y empleados sobre la documentación es vital. Si la documentación carece de información, contiene información incorrecta o simplemente es difícil de leer, los lectores tendrán dificultades para obtener valor. Además, la retroalimentación puede ayudarte a mejorar la documentación existente para proporcionar más valor a los clientes, impulsando el éxito empresarial mediante una compartición de conocimientos de calidad.

Docsie Vocally es un servicio integral de monitorización y respuesta a comentarios. Permite a los lectores calificar documentos individuales en una escala del uno al cinco, con comentarios para explicar las razones de su calificación. Los propietarios y administradores de Docsie pueden leer estos comentarios, obteniendo información sobre los éxitos y deficiencias de tu documentación.

Las bases de conocimiento de autoservicio están diseñadas para minimizar los requisitos de soporte, pero esto también significa que es poco probable que los clientes persistan con documentación deficiente, buscando alternativas entre competidores que ofrezcan mejor documentación. Para abordar este problema, Docsie Vocally registra las interacciones de los usuarios mientras leen tu documentación. Esto destacará dónde encontraron un problema en un documento y qué contenido está causando el problema. Los redactores pueden usar esta retroalimentación para editar la documentación y actuar según los comentarios de los usuarios. Con el tiempo, esto mejorará la calidad del conocimiento documentado, permitiendo a los clientes ayudarse a sí mismos.

Empoderar a los clientes es una excelente manera de atraer nuevos negocios, reducir costos y retener clientes. Según Zendesk, alrededor del 67% de los clientes prefieren el autoservicio a hablar por teléfono[5]. Forrester Research y Oracle también descubrieron que el autoservicio puede reducir los costos de soporte en 11€ por llamada[6]. Finalmente, un estudio de Microsoft destaca que el 90% de los clientes espera una opción de autoservicio[7].

En resumen, los clientes prefieren y esperan un autoservicio de calidad, y proporcionar esta opción puede reducir significativamente los costos de soporte. Al crear una base de conocimientos de autoservicio en Docsie y mejorar la calidad de la documentación con retroalimentación a través de Docsie Vocally, puedes satisfacer las demandas cambiantes de los clientes mediante documentación digital. Obtén más información sobre Docsie Vocally aquí.

Versionado de documentos

Especialmente en empresas tecnológicas, las nuevas versiones de software o servicios pueden introducir problemas con la documentación. La nueva versión puede incluir flujos de trabajo diferentes a versiones anteriores, o terminología diferente que puede confundir a los usuarios. Al mismo tiempo, la nueva documentación puede no aplicarse a versiones anteriores de tus servicios, creando lagunas de conocimiento que tienen el potencial de frustrar y alejar a los clientes.

Esta es una práctica importante con la documentación digital. Los clientes pueden necesitar versiones anteriores de tu software para compatibilidad con su hardware, o simplemente elegir no actualizar a una nueva versión. Por tanto, las empresas siempre deben atender a su base de usuarios independientemente del número de versión que utilicen.

Docsie aborda este problema con el versionado de documentos. Cuando actualizas un documento en Docsie, puedes conservar versiones anteriores con fines de redundancia. Los clientes en la versión 2 de tu servicio pueden seleccionar la documentación correcta, mientras que los clientes en la versión 1 siguen teniendo acceso a la documentación anterior. Esto se llama fragmentación; cuando tu base de clientes se divide entre múltiples versiones del mismo software. Docsie reduce el impacto de la fragmentación, garantizando que el conocimiento esté disponible sin importar la versión utilizada.

El versionado de documentos asegura que la información correcta esté disponible cuando se necesite. También ayuda con la trazabilidad, especialmente cuando múltiples redactores trabajan en la misma pieza de contenido. El versionado también reduce la duplicación, consolidando tu documentación para facilitar el acceso.

¿Tu empresa actualiza regularmente su documentación? ¿Tus clientes tienen dificultades para encontrar la información correcta para versiones actuales e históricas de tu software y servicios? Si es así, puede ser el momento de aplicar la mejor práctica de versionado de documentos a través de un DMS como Docsie. Puedes encontrar más información sobre el versionado de documentos de Docsie aquí.

Hábitos de documentación del personal

Tu gente crea documentación, pero también puede crear problemas con ella. Durante la fase de borrador, los redactores pueden usar diferentes tamaños o tipos de fuente, o iconografía y gráficos obsoletos. Estas diferencias son fáciles de pasar por alto para los empleados que trabajan con contenido a diario, pero los clientes tienen más probabilidades de notarlas. El resultado es una documentación inconsistente, impulsada por inconsistencias en el enfoque de creación y publicación de contenido en toda tu plantilla.

Docsie ayuda a las empresas a abordar la inconsistencia de contenido con el Centro de Documentación Docsie. Puedes establecer un tipo y tamaño de fuente predeterminados, agregar logotipos o ilustraciones de la empresa, y definir parámetros de hoja de estilo CSS para usar en un sitio web o base de conocimientos de la empresa. Estas opciones se propagarán desde Docsie a cualquier página web con contenido incrustado de Docsie, utilizando los mismos colores, fuentes y logotipos en todas partes donde se publique tu contenido.

Esto simplifica los flujos de trabajo de gestión y publicación de contenido. En lugar de editar páginas individuales, las empresas pueden establecer un marco de diseño de contenido una vez en Docsie y aplicar esos cambios en todas partes. Esto se conoce como gestión centralizada u orquestación. El proceso de editar cada documento o página individualmente puede parecer factible para bibliotecas de contenido más pequeñas, pero este proceso no se escalará eficientemente a medida que la biblioteca crezca en amplitud y profundidad.

En resumen, Docsie trabaja para preparar tus flujos de trabajo de gestión de contenido para el futuro, minimizando las cargas administrativas de bajo nivel. Al comenzar con la escala en mente, las grandes bibliotecas de contenido pueden gestionarse con simplicidad, estableciendo marcos de diseño de contenido una vez y desplegándolos en todas partes con Docsie. Puedes obtener más información sobre los Centros de Documentación Personalizados de Docsie usando Docsie Manager aquí.

Almacenamiento centralizado de documentación

Sobre el tema de la centralización, las ubicaciones de almacenamiento de documentos pueden ayudar o dificultar los flujos de trabajo de gestión y publicación. Puedes almacenar documentación en una intranet o sitio SharePoint, en Dropbox o Google Drive, y en particiones de almacenamiento locales o en la nube. Cada opción funciona de forma aislada, pero puede causar caos cuando se utilizan simultáneamente.

Un empleado necesita acceder a un documento. El documento está almacenado en un sitio SharePoint. El empleado lo descarga y lo guarda en su partición de almacenamiento de cuenta. Una herramienta de sincronización de archivos empresariales lo sube a la nube automáticamente. El empleado envía el documento a través de Slack a un colega. Eso son cuatro copias del mismo documento en circulación en tu red informática, con descentralización en cuatro servicios o herramientas diferentes.

Docsie aborda este caos descentralizado centralizando los documentos en una única ubicación de almacenamiento. Cuando subes un documento, Docsie coloca el documento en un estante. Nos referimos a los documentos como libros, con cada estante llenándose de libros para formar una biblioteca de contenido. Los empleados pueden iniciar sesión en Docsie para encontrar toda tu documentación, con filtrado que entrega documentación relevante por departamento o antigüedad usando controles de acceso basados en roles (RBAC). Desde aquí, los empleados pueden publicar documentos directamente en tu sitio web, editar textos de documentación, verificar diferentes versiones y ver comentarios de clientes o colegas.

Ahora, cuando un empleado necesita acceder a un documento, todo lo que tiene que hacer es abrir Docsie. Pueden buscar documentos, exportar en formatos de archivo comunes y compartir enlaces directos a libros o estantes de Docsie. Para usuarios externos, pueden ser invitados por propietarios y administradores para acceso directo a libros y estantes de Docsie autorizados, sin comprometer la seguridad. ¡Es como carpetas y archivos en un disco duro, pero con un poco de magia Docsie! Puedes obtener más información sobre estantes y libros de Docsie aquí.

Gobernanza, riesgo y cumplimiento documental

La mayoría de la documentación se creará para el dominio público. Aun así, alguna documentación puede ser confidencial. Esto presenta la necesidad de gestión de gobernanza, riesgo y cumplimiento (GRC). Las políticas de GRC pueden usarse para gobernar el acceso a documentos confidenciales, controlar permisos de documentos para redactores y lectores, y prevenir la publicación accidental de documentación en fase de borrador.

Docsie utiliza controles de acceso basados en roles (RBAC) para gobernar los permisos en la plataforma. Así es como Docsie ayuda a las empresas a gestionar flujos de trabajo de GRC, definiendo roles de usuario y asignando permisos basados en antigüedad o departamento. Estos roles incluyen Visor, Editor, Administrador y Propietario. A los visores se les concede acceso de solo lectura a los documentos, mientras que a los editores se les conceden permisos de lectura y escritura. Los administradores pueden asignar roles para gestionar quién puede leer, escribir o ambos por libro o por estante. El propietario puede gestionar cada usuario y documento en una organización Docsie, y es el único rol de usuario que puede eliminar una organización completa. En este ejemplo, la organización podría ser Docsie, con estantes que contienen libros sobre diferentes funcionalidades en Docsie.

En conclusión, GRC es importante para gestionar el acceso a la documentación. Con muy poco acceso, los empleados no podrán trabajar en la documentación. Con demasiado acceso, los empleados pueden publicar accidentalmente documentación sin terminar, o acceder a documentos confidenciales reservados para ejecutivos y gerentes. Docsie te ayuda a encontrar un equilibrio entre acceso y seguridad, haciendo que la plataforma sea adecuada para almacenar cualquier tipo de documento.

¿Este documento es sensible, cómo puedo prevenir el acceso no autorizado? ¿Cómo puedo dar a mi equipo permisos de escritura, mientras solo doy a otros equipos acceso de solo lectura? Un redactor independiente necesita permiso para editar este documento, ¿cómo puedo hacerlo? Si tu empresa se está haciendo estas preguntas, ¡Docsie tiene las respuestas! Puedes encontrar más información sobre la gestión de permisos de Docsie aquí.

Colaboración en equipo

El contenido rara vez es elaborado por una sola persona. Cuando múltiples redactores están trabajando en tu biblioteca de documentación, la colaboración es crítica.

¿Qué procesos siguen tus empleados cuando trabajan en documentación? Un ejemplo sería buscar en una unidad de red documentos existentes y descargarlos a un ordenador. A continuación, el redactor puede enviar un borrador final por correo electrónico a un colega para una mayor revisión. El borrador aprobado puede subirse a un sistema de gestión de contenido (CMS) listo para publicar. Más tarde en el día, alguien nota un problema y envía una versión anotada de vuelta al redactor a través de Slack. Este flujo de trabajo puede funcionar, pero se puede simplificar.

Docsie reduce el número de herramientas que necesitas con una funcionalidad integral de colaboración en equipo. Puedes encontrar documentos en Docsie, escribir y editar, compartir cambios con miembros del equipo, chatear y anotar, y publicar en Internet sin salir nunca del panel de control de Docsie. Esto elimina la necesidad de descargar, subir, enviar correos electrónicos y gestionar un CMS, ¡permitiéndote simplemente gestionar tus documentos con Docsie! Los miembros del equipo pueden ser etiquetados usando @mención, las conversaciones de chat están aisladas para cada libro Docsie, y los colaboradores externos pueden ser invitados con facilidad para una colaboración completa en equipo en cualquier ubicación.

Al minimizar el número de herramientas requeridas, los empleados pueden centrarse en crear contenido en lugar de cambiar entre software. Esto acelera los flujos de trabajo de creación de contenido minimizando clics desperdiciados, con comentarios y sugerencias de colegas fácilmente accesibles en la barra de herramientas derecha. No más compartir enlaces, no más versiones obsoletas de documentos, no más correos electrónicos o mensajes de chat perdidos: todo lo relacionado con tus documentos está centralizado en Docsie.

Aplica las mejores prácticas a tus documentos con Docsie

A medida que pasamos del papel a los píxeles, una buena gestión documental es vital. Al aplicar estas mejores prácticas a la documentación digital, las empresas pueden crear y compartir conocimientos que ofrezcan valor real a los clientes mientras optimizan los flujos de trabajo de contenido y reducen costos. La única pregunta es: ¿cómo aplicas estas mejores prácticas?

Ahí es donde entra Docsie. Docsie se basa en estas mejores prácticas de documentación, aplicándolas automáticamente para optimizar la creación, gestión y publicación de contenido. La plataforma está diseñada para trabajar con todo tipo de documentación, alineándose estrechamente con los requisitos típicos de DMS empresariales. Durante la importación y exportación, la documentación de Docsie utiliza formatos de archivo abiertos y compatibles para aumentar la accesibilidad. Las empresas pueden leer y actuar según los comentarios de documentación de los clientes utilizando Docsie Vocally, mejorando la calidad del conocimiento y reduciendo errores de contenido. El versionado de documentos te permite conservar versiones históricas para redundancia de información. Los marcos de diseño de contenido y marca pueden establecerse una vez y aplicarse en todas partes con el Centro de Documentación Personalizado. Todo está almacenado en un lugar: el Portal Docsie, para que los empleados puedan encontrar rápidamente un documento en lugar de buscar en su ordenador, unidad en la nube o correo electrónico. Los permisos pueden establecerse para gestionar GRC, evitando el acceso no autorizado a documentos sensibles. Finalmente, los colegas pueden chatear, compartir, vincular, adjuntar y conceder acceso a contratistas para la colaboración centralizada del equipo en Docsie.

Crea documentación que tus clientes amarán, sin la complejidad. Si tu empresa está buscando una solución DMS, ¡considera probar Docsie! Simplemente ponte en contacto con nuestro equipo de ventas, que estará encantado de guiarte a través de una demostración de 15 minutos de la plataforma Docsie.


[1] <https://www.softwareadvice.com/cms/industryview/go-paperless-with-document-management-software/>

[2] <https://www.stopwaste.org/at-work/reduce-and-reuse/reduce-paper-use/the-impact-of-paper-waste#2>

[3] <https://fcw.com/articles/2013/08/08/va-data-breaches.aspx>

[4] <https://www.greenamerica.org/sites/default/files/inline-files/Paper%20Facts%202017.pdf>

[5] <https://www.zendesk.com/blog/searching-for-self-service/>

[6] <https://www.slideshare.net/UniWeb/the-total-economic-impact-of-click-to-call-and-click-to-chat>

[7] <https://download.microsoft.com/documents/en-us/dynamics/Global_State_of_Multichannel_Customer_Service_Report.pdf.pdf>

Related Articles

Ready to Transform Your Documentation?

Discover how Docsie's powerful platform can streamline your content workflow. Book a personalized demo today!

Book Your Free Demo
4.8 Stars (100+ Reviews)
Tal F

Tal F

VP of Customer Success @ Docsie