¿Qué es la documentación del software?

El software se refiere a rutinas y programas desarrollados para un sistema informático que permiten al usuario realizar tareas o interactuar de otra manera con la computadora. El software puede ser proporcionado por el fabricante como un componente del sistema o creado como aplicaciones independientes por el fabricante o por terceros. La documentación es una descripción de un producto y cómo usarlo. La documentación del software describe las aplicaciones de software y cómo utilizarlas.

La documentación de software impresa, a veces denominada manuales de software, a menudo se configura como un libro, con una página de título, tabla de contenido, cuerpo e índice, y a menudo tiene algunos componentes típicos. El primer componente que la mayoría de los usuarios necesita es una guía de instalación, y se proporcionan guías separadas para los distintos sistemas operativos en los que funciona el software, según sea necesario. La guía de instalación enumera las especificaciones necesarias para ejecutar el software, incluidos los sistemas operativos de la computadora, RAM, espacio en el disco duro, una conexión a Internet y cualquier otro requisito o complemento, como periféricos. A esto le siguen instrucciones paso a paso para la instalación, que pueden ser de un CD-ROM, un DVD o una descarga, por ejemplo. En general, se explican las características inusuales del instalador y la explicación de las opciones de instalación personalizadas, como ubicaciones alternativas o instalaciones optimizadas.

Una guía de “inicio rápido” suele ser la siguiente parte de la documentación de software impresa que se utiliza. Continuando donde termina la guía de instalación, la guía de inicio rápido ayuda al usuario a comenzar con el software y sus operaciones básicas. Esta sección se puede organizar de diversas formas, según convenga al software en particular. Un método popular para aplicaciones orientadas a tareas es una introducción basada en proyectos en la que el usuario aprende la funcionalidad básica del software mientras completa algunas mini lecciones.

Otros elementos que uno esperaría encontrar en la documentación impresa del software incluyen un desglose completo de las características, con énfasis en las características nuevas de la última versión; una lista de actualizaciones desde las versiones anteriores, posiblemente incluyendo errores corregidos; información sobre cómo obtener soporte técnico; explicaciones de mensajes de error; e información para usuarios avanzados o «avanzados». Los juegos y otras aplicaciones de software pueden incluir hojas de trucos o sugerencias en su documentación.

La documentación de software impresa no es la única. En primer lugar, la documentación impresa también puede estar disponible en línea o en formato pdf. La documentación adicional también puede estar disponible en forma de sugerencias de herramientas y pantallas de ayuda dentro de la propia aplicación, preguntas frecuentes: listas de preguntas frecuentes junto con respuestas, artículos de búsqueda, capacitación web, videos y otros formatos.
La calidad de la documentación del software varía bastante, y esto es particularmente cierto en el caso de los manuales de software. Los buenos pueden ser excelentes, mientras que los que no están bien ejecutados pueden dejar a los usuarios con muchas preguntas. También hay usuarios que no se molestarán en buscar la documentación antes de hacer preguntas en los foros del fabricante del software.