Diferentes tipos de Documentación del Sistema

La documentación del sistema consiste en material escrito utilizado para describir las aplicaciones de un hardware o software del sistema. La documentación se puede mostrar como manuales impresos, tarjetas flash, páginas web o de pantalla en el texto de ayuda. La documentación del sistema es un componente vital del éxito de cualquier sistema informático. Sin embargo, muchos desarrolladores tienen dificultades para la creación de la documentación suficiente para sus productos. Diferentes tipos de documentación tienen diferentes objetivos, por lo que el contenido de cualquier documentación dependerá de su público objetivo.

El propósito de la documentación del proyecto describe el proyecto como un todo. La documentación del proyecto proporciona a los ejecutivos, gerentes y empleados una visión amplia de métodos propuestos, los recursos y los objetivos del proyecto. Los documentos de la propuesta de proyecto muestran los ejecutivos de las metas y el presupuesto del proyecto. Las especificaciones técnicas se describen los requisitos de hardware y software para los proyectos. El plan del proyecto se detallan los pasos de los programadores, técnicos y diseñadores tomarán para lograr los objetivos del proyecto.

documentos de prueba ilustran los planes para probar el producto antes de su lanzamiento. El departamento de control de calidad se desarrolla planes de pruebas para tanto internos "alfa" usuarios y externa "beta" probadores. La documentación de prueba incluye instrucciones de prueba - como un conjunto específico de pasos deben seguir los probadores - para determinar si el producto está funcionando como estaba previsto. miembros del personal de control de calidad también se realizan registros de emisión, las listas de errores y los informes de los probadores.

Video: ¿Cómo organizar los archivos físicos?

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. planes del equipo, horarios y actualizaciones de estado son los componentes principales de la documentación del equipo. Las listas de verificación ayudan a los administradores de proyectos ver las tareas que el equipo ha completado. Las actas de las reuniones del equipo permiten a los administradores realizar un seguimiento de varios números, sugerencias y tareas entre los miembros del equipo.

Video: Tipos de Archivos

Video: TIPOS DE ARCHIVOS- TEORIA ARCHIVISTICA

Video: clasificación de documentación interna y externa

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 contienen un lenguaje claro y conciso. El manual de usuario suele ser el componente principal de la documentación para el usuario, pero los usuarios también se basan en otras fuentes. recursos de formación - incluyendo manuales y videos - pueden ayudar a los usuarios de forma rápida y fácil de entender cómo funciona el sistema. Cuando el sistema no funciona como se esperaba, una guía de solución de problemas puede ayudar al usuario a encontrar y resolver el problema.