MANUALES

MANUALES

MANUAL DE USUARIO

MANUAL DE OPERACIONES

Manuales y guías de programas informáticos

En algunos sistemas software de negocios, donde los grupos de usuarios tienen acceso sólo a una de la funcionalidad total de la aplicación, es bastante aconsejable preparar una guía de usuario para cada grupo. Un ejemplo de este enfoque puede observarse en la guía Autodesk Topobase 2010 Help[,5 que contiene por separado una Guía del Administrador y las distintas Guías de Usuario, además de una Guía para desarrolladores. Estos manuales son una herramienta valiosa para el entrenamiento en el trabajo.

es un documento de comunicación técnica destinado a dar asistencia a las personas que utilizan un sistema en particular.Por lo general, este documento está redactado por un escritor técnico, como por ejemplo los programadores del sistema o los directores de proyectos implicados en su desarrollo, o el personal técnico, especialmente en las empresas más pequeñas.

Resumen de contenidos y ámbito de aplicación:

• Le ayuda a no olvidarse de ningún punto importante.
• Para todos los sistemas se utiliza el mismo formato común de manual, lo que facilita la localización cruzada de documentación entre sistemas y la detección y resolución de problemas.

La mayoría de los manuales de usuario contienen tanto una guía escrita como imágenes asociadas. En el caso de las aplicaciones informáticas, es habitual incluir capturas de pantalla de cómo el programa debería ser, y manuales que a menudo incluyen diagramas claramente detallados y sencillos que detallan los pasos a realizar por el usuario para llevar a cabo las distintas opciones disponibles. El lenguaje utilizado deberá ser sencillo, dirigido a una audiencia que podrá no entender un lenguaje demasiado técnico.

Los Manuales de usuario y Guías de usuario para la mayor parte de las aplicaciones de software contienen comúnmente todos los contenidos detallados en el apartado anterior. El Starta User Manual es un buen ejemplo de este tipo de documento. Sin embargo, algunos documentos tienen una estructura más fluida con muchos enlaces internos. El Google Earth User Guide es un ejemplo de este tipo de manuales.

manual de instrucciones

Las secciones de un manual de usuario

Los Guías del usuario son más comúnmente asociados con los productos electrónicos, como computadoras y programas.

El término guía se suele aplicar a un documento

que aborda un aspecto específico de un

producto de software

Algunos ejemplos son:

Guía de Instalación o Guía

de Introducción.

El manual de operaciones o del sistema resultante es un elemento importante del conjunto del sistema informático, ya que:

• es un documento que exigen los departamentos internos de calidad o de auditoria, los auditores externos u otras organizaciones y leyes como requisito para documentar sistemas y procesos.

a menudo incluyen:

• una pagina de portada
• una pagina de titulo
• una pagina de derechos de autor
• un prefacio
• una pagina de contenido
• una sección de solución de problemas

Un manual de instrucciones es una libreta en el que se explica paso a paso como realizar cierta tarea. Puede encontrarse en:

• En el mundo de la informática es muy habitual encontrarlo, para realizar la instalación de una aplicación correctamente y qué hacer en caso de tener algún problema.
• Es también habitual encontrar uno cuando compramos cualquier aparato electrónico de cierta complejidad.
• Instrucciones de seguridad, en manufacturas cuya utilización inadecuada podría acarrear riesgos para la salud del usuario.

MANUAL TECNICO

contenido de un manual tecnico

Un Manual técnico es un documento que se hace con la finalidad de dejar documentado, es decir, explicado todo el trabajo que se ha realizado al desarrollar un sistema o proyecto, como la estructura de datos que usaste, cada funcion o procedimiento, cada variable, metodologias, etc. y puede ser un documento impreso o en digital

• plataforma tecnológica
• características del hardware
• características del software
• funcionalidad de procesos
• parámetros del sistema