Documentación digital: Buenas prácticas para informar e inspirar

Avatar of Author
Tal F
on May 04, 2021 · · filed under Product Documentation Best Practices

**Del papel a los píxeles

Hace sólo unas décadas, parecía que todas las empresas utilizaban papel para la documentación. Contratos, políticas, notas de reuniones... todo se hacía en papel, se imprimía y se pasaba de mano en mano, en lugar de adjuntarlo y analizarlo por correo electrónico.

A medida que la tecnología avanzaba, las empresas disponían de más espacio de almacenamiento para la documentación y de los sistemas informáticos necesarios para que los empleados pudieran acceder a estos documentos digitales. Esto marca el inicio de la transición del papel a los píxeles.

El mundo moderno de la documentación digital ofrece numerosas ventajas, pero persisten los problemas. La documentación se utiliza para transmitir información, tanto al personal interno como a los clientes externos. Esto significa que la coherencia del contenido, la facilidad de acceso y la facilidad de gestión son esenciales. Por el contrario, una documentación digital incoherente, inaccesible y difícil de gestionar puede reducir la capacidad de su empresa para transmitir información con eficacia.

Para impulsar la facilidad y la coherencia, 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 gestión de la documentación digital.

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

Permítanos responder a estas preguntas.

Beneficios de la documentación digital

Antes de discutir el qué y el cómo de las mejores prácticas de documentación digital, primero debemos entender los beneficios de la documentación digital:

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

Como se detalla en este estudio de Software Advice, los trabajadores de oficina dedican una media de seis horas a la semana a buscar documentos en papel. Además, los empleados dedican una media de ocho horas semanales a crear informes a partir de documentos en papel, y el 94% afirma que un sistema de gestión documental (SGD) facilita este proceso.[1]

  • Facilidad de acceso** - Estos documentos digitales también pueden compartirse, prácticamente en tiempo real, por correo electrónico o almacenamiento en la nube. Esto evita la necesidad de enviar cartas por correo, eliminando los costes de franqueo o mensajería. También aumenta la velocidad de respuesta, pues los destinatarios ya no tienen que esperar días a que llegue una carta. Además, la documentación digital puede publicarse en su sitio web o en las redes sociales, lo que facilita el acceso a los clientes.

¿Sabía que, según Gartner, por cada dólar que se gasta en imprimir documentos, se gastan otros 6 en su manipulación y distribución? Además, la mitad de los documentos impresos se tiran en 24 horas.[2]

  • A menos que esté oculta bajo llave, la documentación en papel es insegura. Cualquiera puede leerla, hacer una copia y compartirla a su antojo. Por el contrario, la documentación digital puede gobernarse mediante controles de acceso basados en roles (RBAC) para conceder acceso sólo a quienes lo necesiten.

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

  • Beneficios medioambientales** -- Tanto las personas como las empresas buscan formas de reducir su huella medioambiental. La documentación digital es una de ellas. Según Green America, el consumo de papel ha aumentado un 400% en los últimos 40 años, y el sector representa el 4% del consumo mundial de energía[4]. Al optar por la documentación digital, las empresas pueden reducir el uso de papel para luchar contra la deforestación, manteniendo vivos los árboles que absorben las emisiones de carbono y mantienen el hábitat de los animales.

Mejores prácticas con la documentación digital en Docsie.

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

Alinee su DMS con las necesidades de la empresa

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

Docsie es un DMS que simplifica la forma en que su equipo hace documentos. Todas las empresas necesitan una forma de almacenar y compartir documentación, tanto para que el personal interno pueda aprender sobre su función laboral como para que los clientes puedan aprender a utilizar su producto o servicio. Documentos de incorporación de RR.HH., guías de instrucciones de productos, plantillas de comunicación de ventas: todos estos elementos pueden almacenarse y publicarse con la solución DMS adecuada.

¿Qué documentación existe actualmente sobre sus productos y servicios? ¿Su personal utiliza plantillas y marcos cuando se comunica con los clientes? ¿Puede almacenar, compartir internamente y publicar externamente su documentación? Hágase estas preguntas cuando considere una solución DMS como Docsie, y asegúrese de que su DMS está alineado con las necesidades del negocio.

Centrarse en la compatibilidad

La documentación digital puede aumentar la accesibilidad, pero sólo cuando se utilizan formatos de archivo altamente compatibles. Esto es importante en el caso de la documentación descargable, ya que algunos clientes pueden ser incapaces de abrir un archivo. También se aplica a la documentación interna, en la que un empleado que utiliza PDF y otro que utiliza DOCX puede provocar la fragmentación del formato de archivo, lo que obliga a otros empleados a cambiar de paquete de software o a convertir a otro formato para que el archivo sea accesible.

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 habituales, pero menos compatibles porque requieren un visor de PDF. Ten en cuenta quién accederá a estos documentos y almacena la documentación en un formato que se adapte a la base de usuarios más amplia posible.

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

Comentarios útiles

La opinión de los 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 algún valor de su documentación. Además, los comentarios pueden ayudarle a mejorar la documentación existente para proporcionar más valor a los clientes, impulsando el éxito empresarial mediante el intercambio de conocimientos de calidad.

Docsie Vocally es un servicio integral de seguimiento y respuesta a los comentarios. Permite a los lectores calificar piezas individuales de documentación en una escala de uno a cinco, con comentarios para explicar las razones de su calificación. Los propietarios y administradores de Docsie pueden leer estos comentarios para conocer mejor el éxito y los defectos de su 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 una mala documentación - en lugar de buscar una alternativa con los competidores que proporcionan una mejor documentación. Para hacer frente a este problema, Docise Vocally registrará las interacciones de los usuarios mientras leen su documentación. Esto pondrá de relieve dónde encontraron un problema en un documento, y qué contenido está causando el problema. Los redactores pueden utilizar esta información para editar la documentación y actuar en consecuencia. Con el tiempo, esto mejorará la calidad del conocimiento de la documentación, capacitando a los clientes para ayudarse a sí mismos.

La capacitación de los clientes es una excelente forma de atraer nuevos negocios, reducir costes y retener a los clientes. Alrededor del 67% de los clientes prefieren el autoservicio a hablar por teléfono, según Zendesk[5]. Forrester Research y Oracle también descubrieron que el autoservicio puede reducir los costes de asistencia en 11 dólares por llamada[6]. Por último, un estudio de Microsoft destaca cómo el 90% de los clientes espera una opción de autoservicio[7].

En resumen, los clientes prefieren y esperan un autoservicio de calidad, y ofrecer esta opción puede reducir significativamente los costes de asistencia. Al crear una base de conocimientos de autoservicio en Docsie y mejorar la calidad de la documentación con comentarios a través de Docsie Vocally, puede satisfacer las demandas cambiantes de los clientes a través de la documentación digital. Más información sobre Docsie Vocally aquí.

**Versionado de documentos

Especialmente en las 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 las versiones anteriores, o terminología diferente que puede confundir a los usuarios. Al mismo tiempo, es posible que la nueva documentación no se aplique a versiones anteriores de sus servicios, creando lagunas de conocimiento que pueden frustrar y alejar a los clientes.

Esta es una práctica recomendada importante en la documentación digital. Los clientes pueden necesitar versiones anteriores de su software por compatibilidad con su hardware, o simplemente decidir no actualizarse a una nueva versión. Por lo tanto, las empresas siempre deben atender a su base de usuarios, independientemente del número de versión que se utilice.

Docsie aborda este problema con el versionado de documentos. Cuando actualiza un documento en Docsie, puede conservar las versiones anteriores por motivos de redundancia. Los clientes de la versión 2 de su servicio pueden seleccionar la documentación correcta, mientras que los clientes de la versión 1 siguen teniendo acceso a la documentación anterior. Esto se denomina fragmentación, cuando su base de clientes está dividida en varias versiones del mismo software. Docsie reduce el impacto de la fragmentación, garantizando que el conocimiento esté disponible independientemente de la versión que se utilice.

El control de versiones de documentos garantiza que la información correcta esté disponible cuando se necesite. También ayuda a la trazabilidad, especialmente cuando varios redactores trabajan en el mismo contenido. El control de versiones también reduce la duplicación y consolida la documentación para facilitar el acceso.

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

Hábitos de documentación de la plantilla

Su personal crea documentación, pero también puede crear problemas con la documentación. Durante la fase de borrador, los redactores pueden utilizar tamaños o tipos de letra diferentes, o iconografía y material gráfico obsoletos. Estas diferencias son fáciles de pasar por alto para los empleados que trabajan con contenido todos los días, pero es más probable que los clientes se den cuenta. El resultado es una documentación incoherente, impulsada por las incoherencias en el enfoque de la creación y publicación de contenidos en toda su plantilla.

Docsie ayuda a las empresas a hacer frente a la incoherencia de los contenidos con Docsie Documentation Hub. Puede establecer un tipo y tamaño de fuente predeterminados, añadir logotipos o ilustraciones de la empresa y definir parámetros de hojas de estilo CSS para su uso en el sitio web de la empresa o en la base de conocimientos. Estas opciones se propagarán desde Docsie a cualquier página web con contenido incrustado Docsie, utilizando los mismos colores, fuentes y logotipos en todas partes su contenido se publica.

Esto simplifica la gestión de contenidos y los flujos de trabajo de publicación. En lugar de editar páginas individuales, las empresas pueden establecer un marco de diseño de contenidos 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 las bibliotecas de contenidos más pequeñas, pero este proceso no se ampliará de manera eficiente a medida que la biblioteca crezca en amplitud y profundidad.

En resumen, Docsie trabaja para que sus flujos de trabajo de gestión de contenidos estén preparados para el futuro minimizando las cargas de trabajo administrativas de bajo nivel. Al comenzar con la escala en mente, las grandes bibliotecas de contenido se pueden gestionar con simplicidad, estableciendo marcos de diseño de contenido una vez y desplegando en todas partes con Docsie. Puede obtener más información sobre los centros de documentación personalizados de Docsie utilizando el Gestor de Docsie aquí.

Almacenamiento centralizado de documentación

En cuanto al 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 la documentación en una intranet o en un sitio de SharePoint, en Dropbox o Google Drive, y en particiones de almacenamiento locales o en la nube. Cada una de estas opciones funciona de forma aislada, pero puede provocar el caos cuando se utilizan simultáneamente.

Un empleado necesita acceder a un documento. El documento está almacenado en un sitio de SharePoint. El empleado lo descarga y lo guarda en la partición de almacenamiento de su cuenta. Una herramienta de sincronización de archivos empresariales lo sube automáticamente a la nube. El empleado envía el documento a través de Slack a un compañero. Eso son cuatro copias del mismo documento en circulación en su red de TI, con descentralización a través de 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 lo coloca en una estantería. Nos referimos a los documentos como libros, y cada estantería se llena de libros para formar una biblioteca de contenidos. Los empleados pueden iniciar sesión en Docsie para encontrar toda su documentación, con filtros que ofrecen documentación relevante por departamento o antigüedad utilizando controles de acceso basados en roles (RBAC). Desde aquí, los empleados pueden publicar documentos directamente en su sitio web, editar el texto de la documentación, comprobar diferentes versiones y ver los comentarios de clientes o compañeros.

Ahora, cuando un empleado necesite acceder a un documento, todo lo que tiene que hacer es abrir Docsie. Pueden buscar documentos, exportarlos en formatos de archivo comunes y compartir enlaces directos a libros o estanterías de Docsie. Los usuarios externos pueden ser invitados por los propietarios y administradores para acceder directamente a los libros y estanterías Docsie autorizados, sin comprometer la seguridad. Es como las carpetas y los archivos de un disco duro, pero con la magia de Docsie. Puede obtener más información sobre las estanterías y libros Docsie aquí.

Gobernanza documental, riesgo y cumplimiento

La mayor parte de la documentación se creará para el dominio público. Sin embargo, algunos documentos pueden ser confidenciales. Esto plantea la necesidad de gestionar los riesgos de gobernanza y cumplimiento (GRC). Las políticas de GRC pueden utilizarse para regular el acceso a documentos confidenciales, controlar los permisos de escritura y lectura de documentos y evitar la publicación accidental de documentación en fase de borrador.

Docsie utiliza controles de acceso basados en roles (RBAC) para regular los permisos en la plataforma. Así es como Docsie ayuda a las empresas a gestionar los flujos de trabajo de GRC, definiendo roles de usuario y asignando permisos en función de la antigüedad o el departamento. Entre estas funciones se incluyen las de espectador, editor, administrador y propietario. A los espectadores se les concede acceso de sólo lectura a los documentos, mientras que a los editores se les conceden permisos de lectura y escritura. Los administradores pueden asignar funciones para gestionar quién puede leer, escribir o ambas cosas por libro o estantería. El propietario puede gestionar todos los usuarios y documentos de una organización Docsie, y es la única función de usuario que puede eliminar toda una organización. En este ejemplo, la organización podría ser Docsie, con estanterías que contengan libros sobre diferentes funcionalidades de Docsie.

En conclusión, la 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 inacabada, o acceder a documentos confidenciales reservados a ejecutivos y directivos. Docsie le 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 evitar el acceso no autorizado? ¿Cómo puedo dar a mi equipo permisos de escritura, mientras que a otros equipos sólo les doy acceso de lectura? Un redactor independiente necesita permiso para editar este documento, ¿cómo puedo hacerlo? Si su empresa se hace estas preguntas, Docsie tiene las respuestas. Puede encontrar más información sobre la gestión de permisos de Docsie aquí.

Colaboración en equipo

El contenido rara vez lo elabora una sola persona. Cuando varios redactores trabajan en su biblioteca de documentación, la colaboración es fundamental.

¿Qué procesos siguen sus empleados cuando trabajan en la documentación? Un ejemplo sería buscar en una unidad de red los 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 que lo revise. A continuación, el borrador aprobado puede cargarse en un sistema de gestión de contenidos (CMS) listo para su publicación. Más tarde, alguien detecta un problema y envía una versión anotada al redactor a través de Slack. Este flujo de trabajo puede funcionar, pero puede simplificarse.

Docsie reduce el número de herramientas necesarias gracias a su completa funcionalidad de colaboración en equipo. Puedes encontrar documentos en Docsie, escribirlos y editarlos, compartir los cambios con los miembros del equipo, chatear y hacer anotaciones, y publicarlos en Internet sin salir del panel de Docsie. Esto elimina la necesidad de descargar, cargar, enviar por correo electrónico y gestionar un CMS, permitiéndole simplemente gestionar sus documentos con Docsie. Se puede etiquetar a los miembros del equipo mediante @mention, las conversaciones de chat se aíslan en cada libro de Docsie y se puede invitar a freelancers externos con facilidad para una colaboración total del equipo en cualquier lugar.

Al minimizar el número de herramientas necesarias, los empleados pueden centrarse en la creación de contenidos en lugar de cambiar de software. Esto agiliza los flujos de trabajo de creación de contenidos al minimizar los clics desperdiciados, y los comentarios y sugerencias de los compañeros son fácilmente accesibles en la barra de herramientas de la derecha. No más enlaces compartidos, 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, la buena gestión de la documentación es vital. Al aplicar estas buenas prácticas a la documentación digital, las empresas pueden crear y compartir conocimientos que ofrecen un valor real a los clientes, al tiempo que agilizan los flujos de trabajo de contenidos y reducen costes. La única pregunta es: ¿cómo aplicar estas buenas prácticas?

Ahí es donde entra Docsie. Docsie se basa en estas mejores prácticas de documentación y las aplica automáticamente para agilizar los flujos de trabajo de creación, gestión y publicación de contenidos. La plataforma está diseñada para trabajar con todo tipo de documentación, ajustándose estrechamente a los requisitos típicos de los 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 los comentarios de los clientes sobre la documentación y actuar en consecuencia mediante Docsie Vocally, lo que mejora la calidad de los conocimientos y reduce los errores de contenido. El versionado de documentos permite conservar versiones históricas para redundancia de la información. La marca y los marcos de diseño de contenidos pueden establecerse una vez y aplicarse en todas partes con el centro de documentación personalizada. Todo se almacena en una única ubicación, el portal Docsie, para que los empleados puedan encontrar rápidamente un documento en lugar de tener que buscarlo en el ordenador, en la nube o en el correo electrónico. Se pueden establecer permisos para gestionar la GRC, lo que impide el acceso no autorizado a documentos confidenciales. Por último, los compañeros pueden chatear, compartir, vincular, adjuntar y conceder acceso a los contratistas para una colaboración en equipo centralizada en Docsie.

Cree documentación que encantará a sus clientes, sin la complejidad. Si su empresa está buscando una solución DMS, considere la posibilidad de probar Docsie. Sólo tiene que ponerse en contacto con nuestro equipo de ventas, que estará encantado de guiarle 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


Subscribe to the newsletter

Stay up to date with our latest news and products