Manual de usuario
La versión actual de la página aún no ha sido revisada por colaboradores experimentados y puede diferir significativamente de la
versión revisada el 10 de agosto de 2019; la verificación requiere
1 edición .
Un manual de usuario es un documento cuyo propósito es ayudar a las personas a utilizar un sistema. El documento forma parte de la documentación técnica del sistema y normalmente lo prepara un redactor técnico .
La mayoría de los manuales de usuario contienen imágenes además de descripciones textuales. En el caso del software , se suelen incluir capturas de pantalla en el manual , y se incluyen dibujos sencillos y comprensibles en la descripción del hardware. Se utiliza un estilo y un lenguaje accesibles para la audiencia prevista, la jerga se reduce al mínimo o se explica en detalle.
Contenidos
Un manual de instrucciones típico contiene:
- Anotación que proporciona un resumen del contenido del documento y su propósito.
- Introducción con enlaces a documentos relacionados e información sobre la mejor manera de utilizar este manual
- Pagina de contenido
- Capítulos que describen cómo utilizar al menos las funciones más importantes del sistema
- Capítulo que describe posibles problemas y soluciones
- Preguntas frecuentes y respuestas
- Dónde más encontrar información sobre el tema, información de contacto
- Glosario y, en documentos más grandes, índice
Todos los capítulos y párrafos, así como las figuras y tablas, suelen estar numerados para que se pueda hacer referencia a ellos dentro del documento o desde otro documento. La numeración también facilita la vinculación a partes del manual, por ejemplo, cuando el usuario se comunica con el equipo de soporte.
Estándares
La estructura y contenido del documento Guía del usuario del sistema automatizado se regulan en el apartado 3.4 del documento RD 50-34.698-90 (anulado por auto de Rosstandart de 12 de febrero de 2019 N 216). La estructura y el contenido de los documentos Guía del operador , Guía del programador, Guía del programador del sistema están regulados por GOST 19.505-79, GOST 19.504-79 y GOST 19.503-79, respectivamente.
- Un conjunto de estándares y pautas para sistemas automatizados (GOST 34)
- RD 50-34.698-90 SISTEMAS AUTOMATIZADOS. REQUISITOS PARA EL CONTENIDO DE LOS DOCUMENTOS
- El Sistema Unificado para la Documentación de Diseño (ESKD) define el documento "Manual de Operación" y otros documentos:
- El Sistema de Documentación del Programa Unificado (ESPD) define los documentos "Manual del Operador", "Manual de Mantenimiento" y su estructura:
- GOST 19.101-77 Tipos de programas y documentos de programas.
- GOST 19.105-78 Requisitos generales para los documentos del programa
- GOST 19.505-79 Manual del operador. Requisitos de contenido y diseño.
- GOST 19.508-79 Manual de mantenimiento. Requisitos de contenido y diseño.
Véase también
Enlaces