Guía para la elaboración de

manuales e instructivos
Registro de cambios

Fecha Usuario Versión Acciones

22/03/2017 Clara Roldan 1.0 Creación

Sede Medellín Calle 14 Nº 52 A 174 / Teléfono: +57 (4) 389 7000

Sede Bogotá Carrera 69 Nº 98 A - 11 Piso 2 / C.C. Floresta Outlet - Teléfono: + 57 (1) 486 3500
Introducción

Los manuales o instructivos son documentos que brindan indicaciones claras de cómo
realizar una actividad para lograr un objetivo. Es un documento técnico que a través de
imágenes e instrucciones cortas servirá como guía frente a un proceso de instalación o
configuración, donde cualquier persona con conocimientos básicos tenga la posibilidad
de ejecutar la acción de manera exitosa.
En este manual, se brindan herramientas para que construya un manual de usuario que
cumpla con las normas y documentación necesarias para que el usuario instale y/o
configure una aplicación o software.

Esta guía se basa en las normas IEEE Std 1063 – 2001 para la documentación de
manuales para usuarios de Software.

Sede Medellín Calle 14 Nº 52 A 174 / Teléfono: +57 (4) 389 7000

Sede Bogotá Carrera 69 Nº 98 A - 11 Piso 2 / C.C. Floresta Outlet - Teléfono: + 57 (1) 486 3500
Pasos para la elaboración de un
manual de usuario

El estándar IEEE std 1063-2001 brinda un marco de referencia para establecer qué
partes deben conformar cualquier documento que será utilizado por usuarios de un
sistema o programa. Estas partes son:

1. Identificación de los datos (Título): El título debe comunicar la temática del

contenido del manual. Se ubica en la portada del documento, conservando el
diseño y la imagen corporativa de la institución para la cual se esté elaborando el
manual.

Formato y diseño

Teniendo en cuenta que el manual es para uso institucional, se debe conservar la

identidad Visual Corporativa de Emtelco. A continuación se señala las condiciones para
una buena presentación.

 Logotipo: Debe ubicarse en la parte superior del manual para conservar su

expresión visual.

 Tipografía: Las tipografías corporativas son la “Arial” y la “Vag Rounded”. La

fuente “Vag Rounded” será usada para títulos y “Arial” para el texto seguido, el
tamaño de la fuente debe ser 12.

 Colores institucionales: Los colores institucionales son 9 en total, los cuales

se sugieren para presentar gráficos de Excel.

La paleta de colores puede consultarla ingresando a Zona E – Normatividad

– Identidad de marca.

http://intranetzonae/ZonaE/images/documentos/manual%20de%20marca%20e
mtelco%202016.pdf

Sede Medellín Calle 14 Nº 52 A 174 / Teléfono: +57 (4) 389 7000

Sede Bogotá Carrera 69 Nº 98 A - 11 Piso 2 / C.C. Floresta Outlet - Teléfono: + 57 (1) 486 3500
 2. Tabla de contenido: La tabla de contenido facilita la búsqueda de temas dentro de
documentos extensos. por lo anterior, solo es necesario cuando el manual supera
8 páginas.

3. Lista de ilustraciones: De acuerdo al marco de referencia brindado por la IEEE,

este componente es opcional. Aplica en casos donde la ilustración logra el mismo
objetivo del texto, de ese modo, una lista de ilustraciones facilita la búsqueda
dentro del documento.

4. Introducción: La introducción debe proporcionar al lector una visión breve y

suficiente del objetivo del artículo y del entorno técnico del mismo.

Debe responder las siguientes preguntas:

 ¿Qué es?... Se sugiere redactar una descripción breve del software o aplicación a
instalar
 ¿Para qué?... Para qué sirve la aplicación o software, cuál es su función.
 ¿Para quién?... Es importante dejar claro para que tipo de público va dirigido y que
tipo de conocimientos debe tener para hacer uso del manual.

El estándar IEEE propone los siguientes dos componentes, los cuales serán
reemplazados por el numeral (5) para facilitar la comprensión del público objetivo.

 Información para el uso de la documentación

 Conceptos de las operaciones

5. Requerimientos Técnicos

5.1. Requerimientos de Hardware: Especifique las condiciones de Hardware

que permita un correcto funcionamiento del software o aplicación (Opcional).

5.2. Requerimientos de Software: Detalle las condiciones de Software antes de

iniciar la instalación o configuración, enumere cada software con el que debe
contar y brinde información de donde lo puede obtener. Especifique las
diferentes rutas donde el usuario pueda encontrar los instaladores de
software necesarios y remita a otros manuales de instalación si lo requiere.

Sede Medellín Calle 14 Nº 52 A 174 / Teléfono: +57 (4) 389 7000

Sede Bogotá Carrera 69 Nº 98 A - 11 Piso 2 / C.C. Floresta Outlet - Teléfono: + 57 (1) 486 3500
6. Procedimiento: Un buen procedimiento, debe describir cada acción del proceso,
debe detallar todos los datos que necesitará el usuario para lograr su objetivo. La
descripción de los pasos debe ser inequívoca, exacta y puntual.

A continuación se detallan algunas herramientas para que las instrucciones que

brinde se logren ejecutar con éxito.
 Redacte cada paso en tercera persona, no se incluya porque pierde credibilidad.

 Ingresemos por el menú de inicio. ‘panel de control’

 Ingrese por el menú de inicio. ‘Panel de control’
 Explique o defina conceptos complejos, es recomendable incluir un glosario que
permita mejor entendimiento del manual o procedimiento.

 Sea claro y no salte ningún paso, aunque sea demasiado obvio, porque para
personas con poca experiencia puede que no lo sea.

 Infórmele al lector sobre las alertas que puede encontrar durante el proceso de
instalación. Esto ayudará a que el lector permanezca conectado con el manual.

 Utilice frases cortas que permitan una lectura rápida. Primero la acción, de tal
modo que con un solo vistazo el lector tenga una idea de lo que debe hacer.

 A través del botón de ‘Inicio’, ubicado en la parte baja del computador, haga clic.
 Haga Clic en el botón de ‘Inicio’, en la parte baja del computador.
 Evite utilizar un vocabulario técnico y especializado. Procure que el manual sea
comprensible para lectores con conocimientos básicos.

 Logre que se entienda leyendo solo una vez.

 Sea puntual, evite humor, palabras de cortesía o emociones en el texto.

 “Por favor, seleccione…”

 “Funciona mejor si…”
 Seleccione la opción…
 Conserve un orden claro y lógico.

 Utilice recursos como la Negrita o Cursiva para destacar palabras o ideas.

 Evite redactar frases en mayúscula porque entrega un mensaje más negativo que
positivo.

Sede Medellín Calle 14 Nº 52 A 174 / Teléfono: +57 (4) 389 7000

Sede Bogotá Carrera 69 Nº 98 A - 11 Piso 2 / C.C. Floresta Outlet - Teléfono: + 57 (1) 486 3500
 Incluya recursos visuales como pantallazos o imágenes que permitan mejor gestión
o comprensión del manual.

7. Mensajes de Error y solución de problemas: Enumere los incidentes que se

pueden presentar durante el uso del Software, estos deben ser actualizados cada
vez que se presente un nuevo incidente o se encuentre una nueva solución a los
ya existentes. Los incidentes deben estructurarse de la siguiente forma:

 Síntoma: Describa el mensaje de error que se presenta o la posible falla.

 Problema: Haga una breve descripción de porqué se presenta el error.

 Solución: Procedimiento estructurado de cómo corregir el error. (Siga las

recomendaciones del numeral 6)

 Comentarios Adicionales: Incluya observaciones o comentarios que considere

importante para una solución exitosa (Opcional).

8. Glosario: Lista de palabras desconocidas o difícil comprensión acompañadas de

su significado. Solo es necesario cuando el manual contiene expresiones con
dichas características.

9. Fuentes de información relacionadas: Bibliografías, diccionarios especializados,

monografías o libros electrónicos

10. Características de navegación

11. Index: Un índice es una lista de palabras y el número de página donde se

encuentra dicha palabra, es útil para encontrar términos importantes de manera
rápida y sencilla. De acuerdo al estándar IEEE, este componente es opcional y solo
es necesario cuando el documento supera 40 páginas.

Sede Medellín Calle 14 Nº 52 A 174 / Teléfono: +57 (4) 389 7000

Sede Bogotá Carrera 69 Nº 98 A - 11 Piso 2 / C.C. Floresta Outlet - Teléfono: + 57 (1) 486 3500