Instalador

manuales es el lenguaje utilizado para expresar una idea, se debe ser muy cuidadoso de utilizar expresiones ambiguas o que confundan al usuario y lo más importante, siempre debe aclarar hacia quien va dirigida alguna operación, si al usuario final o a un usuario técnico.

Componentes de un Manual Técnico

Un manual técnico se compone, además de ciertos tópicos, de otros manuales los cuales se pueden adjuntar o incluir directamente. Pero el manual técnico, al igual que cualquier documento posee una estructura básica:

• Portada: contiene el nombre completo del software, logo del software y de la empresa fabricante, Nombre y datos de contacto del fabricante.

• Tabla de contenido: se colocan todos los ítems o tópicos de los cuales consta el manual, es útil colocar estos como hipervínculos a los títulos para más facilidad de navegación por el manual.

• Introducción: una descripción corta, no más de una página, que indique al usuario qué podrá encontrar en el documento y algunas descripciones importantes del software.

• Manuales adjuntos, FAQS: aquí se encuentran los manuales de instalación, de usuario, de procedimientos y FAQS.

Manual de Instalación/Desinstalación

En este manual debe quedar estipulado cómo se debe instalar el software, se suele acompañar de pantallazos o un videotutorial el cual se adjunta al documento. Pero no solamente se ilustra la instalación de la aplicación, sino el software asociado a ella, como por ejemplo la instalación del motor de base de datos y la creación de la misma.

En este ultima aspecto, se debe dejar claro en el manual que ese tipo de instalaciones las deberá realizar un técnico en informática o alguien con el suficiente conocimiento, ya que la instalación por ejemplo de bases de datos no está dirigida a usuarios finales. También siempre dejar siempre en claro temas como permisos de usuario u otras consideraciones si tienen lugar.

Se debe indicar la instalación del software desde que el usuario debe abrir el medio magnético o digital desde donde debe abrir el instalador hasta como el usuario debe desinstalar dicho software.

Manual de Usuario

En este manual se realiza toda la guía para el usuario o usuarios finales, allí queda ilustrado cómo el usuario debe usar y utilizar el software en cada una de sus funciones. Se debe ser lo más claro posible y utilizar un lenguaje amigable y medianamente técnico.

El manual de usuario debe:

• Separar funciones por usuario o perfiles, si los hay.

• Ilustrar cada función principal y sus subfunciones, manteniendo el orden jerárquico.

• Separar cada modulo claramente.

• Utilizar un buen método de navegación entre los ítems del manual.

• Utilizar la mayor didáctica posible (Videos, pantallazos, animaciones, etc.) siempre acompañada de textos.

Manual de Procedimientos

En el manual de procedimientos se enmarcan todos los procedimientos o procesos para poner en marchar el software, configurarlo y para utilizarlo en un entorno real. El manual de procedimientos posee:

• Funcionalidades del software: se describe generalmente cada función del software y sus usuarios.

• Descripción del sistema: se recrea por cada función del software, la forma en cómo el usuario del sistema ejecuta el proceso hasta que entrega un resultado. Por ejemplo: para la función de registrar inmuebles se describe detalladamente desde que el cliente o dueño del inmueble le da los datos de este al usuario del sistema, se registra y se le entrega un reporte de registro.

• Capacitación: se describe como y donde se llevará acabo la capacitación, horario, recursos de hardware y software y el material a usar.

• Activación:

...