Es posible que ya lo haya notado: nunca nos cansamos de enfatizar que la documentación es una parte esencial de cualquier producto. Esto es especialmente cierto para el software empresarial que cubre muchos casos de uso. La mayoría de las soluciones de software solo se pueden utilizar gracias a una documentación detallada. Tenemos comentarios directos de usted, nuestros clientes y socios, sobre cuánto confía en la documentación para realizar sus tareas. Al ser responsable de un entorno de TI que funcione y de procesos fluidos, la documentación faltante o deficiente puede afectar su trabajo diario e incluso el éxito de su negocio.

Dando forma a los documentos

Nuestras altas exigencias a nosotros mismos son producir y entregar servicios de localización y documentación de alta calidad. Pero necesitamos su ayuda: está utilizando los documentos para su trabajo diario, sabe dónde faltan o dónde son lo suficientemente buenos. Por lo tanto, todos los años, el equipo de documentación de SUSE (BCL), llevamos a cabo una encuesta global para recopilar sus comentarios concretos. Por supuesto, no solo "escuchamos" y "leemos" sus ideas. Queremos entender cómo brindarle mejores servicios. Porque nuestro objetivo es mejorar continuamente la documentación para facilitar su uso.

Algunas acciones realizadas

Gracias a los comentarios de las encuestas de los últimos años, ya hemos podido mejorar varias cosas. Uno de los principales puntos débiles de los documentos, según los resultados de la encuesta, fue la 'facilidad de uso'. Otro requisito fue centrarse más en la explicación de soluciones específicas y casos de uso. En 2021, mejoramos la apariencia en línea de nuestros documentos para mejorar la experiencia del usuario. Introdujimos un diseño de tres columnas y varias funcionalidades adicionales útiles para una navegación más fácil. Además, comenzamos a trabajar en un nuevo enfoque de la documentación.

Nuevo enfoque inteligente

Incluso si los enormes manuales y guías de productos monolíticos siguen siendo útiles y es posible que nunca desaparezcan por completo, sabemos que son difíciles de consultar durante su trabajo diario. Los SmartDocs son un proyecto para abordar, entre otros, los requisitos mencionados anteriormente para la facilidad de uso general y la capacidad de navegación mejorada. Nuestra primera prioridad por la presente recae en el usuario, no en el producto. Así nosotros

• intente escribir de una manera que lo ayude a completar las tareas, en lugar de sermonearlo sobre el producto,
• centrarse en las necesidades de nuestros usuarios, y no en las características del producto,
• y tiene como objetivo instruirlo sobre cómo resolver un problema, y ​​no solo cómo usar la interfaz del producto.

Nuestro objetivo es avanzar cada vez más hacia la documentación modular. Proporcionar información basada en soluciones o temas (como ya hacemos con las mejores prácticas de SUSE y la documentación de referencia técnica ) acelerará la productividad.

Otro aspecto importante son las opciones de navegación mejoradas. La modularidad ayuda a mejorar la legibilidad y facilita el consumo de temas. Y finalmente, los artículos pequeños tienen mejores resultados en los motores de búsqueda que los manuales grandes. Además, pueden ser fácilmente consumidos por herramientas de IA. Ya vemos que nuestros SmartDocs ocupan un lugar más alto en los resultados de búsqueda de Google. Entonces, en el futuro, cuando esté buscando contenido o ayuda, es de esperar que tenga la información respectiva rápidamente al alcance de su mano.

Luchando por la perfección

Bueno, déjame ser claro: no estamos viviendo en un mundo perfecto. Y nunca habrá perfección en el negocio del software