IEEE 1063 User Documentation

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)

IEEE Std 1063. Esta norma establece requisitos mínimos sobre la estructura y el contenido de información de la documentación del usuario. Se aplica principalmente a la sustancia técnica en lugar de al estilo. Los usuarios de esta norma pueden desarrollar su propio manual de estilo para usar dentro de sus organizaciones para implementar los requisitos de esta norma.

Resultado de imagen para IEEE 1063 documentacion de usuario

Comentarios

Entradas populares de este blog

Manual de usuario Kiuwan

Estándar