Estándar IEEE Std 1063-2001, para documentación de usuarios

"Contar con un estandar para la documentación de usuarios de software es necesario. El Std 1063-2001 ofrece una buena guía para crear un manual de usuario adecuado"

Muchos de nosotros nos encontramos en el área de la documentación de sistemas (al menos fue mi caso) por coincidencia. La primera ves que uno tiene un acercamiento con el área tiene una noción de los documentos que deben ser parte de un desarrollo o producto de software, pero sin embargo desconoce qué partes o secciones debe contener esos documentos. Por ejemplo ¿qué secciones debe tener un manual de usuario?, o ¿una memoria técnica?, etc.

El estándar IEEE std 1063-2001 brinda ese marco de referencia para establecer qué partes deben conformar cualquier documento que deba ser utilizado por un usuario del sistema o programa en cuestión.

Este estándar solo se aplica a la documentación de usuario, para la documentación de carácter técnico se utilizan otras recomendaciones de las cuales hablaremos en su momento. A grandes rasgos la recomendación del IEEE establece las siguientes partes para un documento que usarán los usuarios. Estas partes son:

1.- Identificación de los datos (paquete, título)

2.- Tabla de contenidos, en documentos con más de 8 páginas

3.- Lista de ilustraciones (optativo)

4.- Introducción

5.- Información para el uso de la documentación

6.- Conceptos de las operaciones

7.- Procedimientos

8.- Información sobre los comandos de software

9.- Mensajes de error y resolución de problemas

10.- Glosario

11.- Referencias

12.- Características de navegación

13.- Índice o Index

14.- Herramientas de búsqueda (en documentos electrónicos)

Estos son los componentes mínimos que debe incluir cualquier documento que use el usuario de software.

El estandar completo en inglés puede ser descargado desde la página:

Estandar IEEE

¿Necesitas un ejemplo de cómo elaborar un manual de usuario?, entonces visita el siguiente link: Elaborar un manual de usuario