La documentación del sistema consiste en material escrito que se utiliza para describir las aplicaciones de un sistema de software o hardware de computadora. La documentación se puede mostrar como manuales impresos, tarjetas flash, páginas web o texto de ayuda en pantalla. La documentación del sistema es un componente vital del éxito de cualquier sistema informático. Sin embargo, muchos desarrolladores tienen dificultades para crear documentación suficiente para sus productos. Los diferentes tipos de documentación tienen diferentes objetivos, por lo que el contenido de cualquier documentación dependerá de su audiencia prevista.
Documentación del proyecto
El propósito de la documentación del proyecto describe el proyecto como un todo. La documentación del proyecto brinda a los ejecutivos, gerentes y empleados una visión amplia de los métodos, recursos y objetivos propuestos por el proyecto. Los documentos de la propuesta del proyecto muestran a los ejecutivos los objetivos y el presupuesto del proyecto. Las especificaciones técnicas describen los requisitos de hardware y software para los proyectos. El plan del proyecto detalla los pasos que los programadores, técnicos y diseñadores tomarán para lograr los objetivos del proyecto.
Documentación de prueba
Los documentos de prueba ilustran los planes para probar el producto antes de su lanzamiento. El departamento de control de calidad desarrolla planes de prueba tanto para usuarios internos "alfa" como para evaluadores externos "beta".La documentación de la prueba incluye instrucciones de prueba, como un conjunto específico de pasos que deben seguir los evaluadores, para determinar si el producto funciona según lo planeado. El personal de control de calidad también recopila registros de problemas, listas de errores e informes de los evaluadores.
Documentación del equipo
El intercambio de ideas entre los miembros del equipo es vital para el éxito de un proyecto. La documentación del equipo registra estos intercambios para su uso en el proyecto actual y en proyectos futuros. Los planes del equipo, los horarios y las actualizaciones de estado son componentes importantes de la documentación del equipo. Las listas de verificación ayudan a los gerentes de proyectos a ver qué tareas ha completado el equipo. Las actas de las reuniones del equipo permiten a los gerentes realizar un seguimiento de diversos problemas, sugerencias y tareas entre los miembros del equipo.
Documentación del usuario
El elemento más crítico de la documentación del sistema es el contenido que llega al cliente. La documentación del usuario debe estar libre de jerga demasiado técnica y contener un lenguaje claro y conciso. El manual del usuario suele ser el componente principal de la documentación del usuario, pero los usuarios también dependen de otras fuentes. Los recursos de capacitación, incluidos manuales y videos, pueden ayudar a los usuarios a comprender rápida y fácilmente cómo funciona el sistema. Cuando el sistema no funciona como se espera, una guía de solución de problemas puede ayudar al usuario a encontrar y resolver el problema.
