IEEE Std 1063-2001

(Revisión de la norma IEEE 1063-1987)

1063 TM

IEEE estándar para el software de documentación

de EEE

del usuario
Standards

IEEE Computer Society

Patrocinado por el
Comité de Normas de Ingeniería de Software
Normas
IEEE
yo

Publicado por
El Instituto de Ingenieros Eléctricos y Electrónicos, Inc. 3 Park Avenue, Nueva
York, NY 10016 hasta 5997, EE.UU.
Imprimir: SH94976

20 de diciembre de de 2001
PDF: SS94976
 IEEE Std 1063-2001
(Revisión de la
norma IEEE 1063-1987)

IEEE estándar para el software de documentación

del usuario

Patrocinador

Comité de Normas de Ingeniería de Software de la

IEEE Computer Society

Aprobada en 5 de diciembre de de 2001

Consejo de Normas IEEE-SA

Abstracto: Los requisitos mínimos para la estructura, el contenido de la información, y el formato de documentación para el usuario, tanto de
documentos impresos y electrónicos que se utilizan en el entorno de trabajo de los usuarios de los sistemas que contienen el software, se
proporcionan en esta norma.

palabras clave: ayuda en línea, documentación de usuario del software, manual de usuario

El Instituto de Ingenieros Eléctricos y Electrónicos, Inc. 3 Park Avenue, Nueva

York, NY 10016 hasta 5997, EE.UU.

Copyright © 2001 por el Instituto de Ingenieros Eléctricos y Electrónicos, Inc. Todos los derechos reservados. Publicado el 20 de
diciembre de 2001. Impreso en los Estados Unidos de América.

Impresión: ISBN 0-7381-3098-2 SH94976

PDF: ISBN 0-7381-3099-0 SS94976

Ninguna parte de esta publicación puede ser reproducida en cualquier forma, en un sistema de recuperación electrónica o de otra manera, sin la previa autorización por escrito del
editor.
IEEE Standards documentos se desarrollan dentro de las Sociedades de la IEEE y los Comités de Coordinación de Normas de la asociación de los
estándares IEEE (IEEE-SA) Standards Board. El IEEE desarrolla sus normas a través de un proceso de consenso, aprobado por el American National
Standards Institute, que reúne a voluntarios que representan distintos puntos de vista e intereses para lograr el producto final. Los voluntarios no son
necesariamente miembros del Instituto y sirven sin compensación. Mientras que el IEEE administra el proceso y establece normas para promover la equidad
en el proceso de desarrollo de consenso, el IEEE no evalúa de forma independiente, prueba o verificar la exactitud de la información contenida en sus
normas.

El uso de un estándar IEEE es totalmente voluntaria. El IEEE se exime de toda responsabilidad en caso de lesiones personales, bienes u otros daños, de cualquier
naturaleza, ya sea directa o indirectamente, especiales, indirectos, consecuentes o compensatoria, como resultado de la publicación, uso o dependencia de esta, o
cualquier otro estándar IEEE documento.

El IEEE no garantiza ni representa la exactitud o el contenido del material contenido en el presente documento, y renuncia expresamente a cualquier garantía expresa o implícita,

incluyendo cualquier garantía implícita de comerciabilidad o aptitud física para un propósito específico, o que el uso del material contenido en el presente documento es gratis de

violación de patentes. documentos IEEE Standards se suministran “ COMO ES . ”

La existencia de un estándar IEEE no implica que no hay otras maneras de producir, probar, medir, compra, mercado, o proporcionar otros bienes y servicios
relacionados con el ámbito de aplicación de la Norma IEEE. Además, el punto de vista expresado en el momento se aprobó un estándar y emitió está sujeto a cambio
producido a través de la evolución en el estado de la técnica y las observaciones recibidas de los usuarios de la norma. Cada estándar IEEE es sometido a revisión al
menos cada cinco años para la revisión o confirmación rea fi. Cuando un documento es más de cinco años de edad y no ha sido fi rmado rea, es razonable concluir
que su contenido, aunque todavía de algún valor, no en su totalidad reflejan el estado actual de la técnica. Se advierte a los usuarios a comprobar para determinar que
tienen la última edición de cualquier estándar IEEE.

Con la publicación de este documento y haciendo disponibles, el IEEE no está sugiriendo o prestación de servicios profesionales o de otro tipo para, o en nombre de, cualquier
persona o entidad. Tampoco es la empresa IEEE para desempeñar cualquier trabajo debido por cualquier otra persona o entidad a otra. Cualquier persona que utilice este, y
cualquier otro documento de estándares de IEEE, deben basarse en el asesoramiento de un profesional competente para determinar el ejercicio de cuidado razonable en cualquier
circunstancia.

Interpretaciones: De vez en cuando pueden surgir preguntas sobre el significado de las porciones de las normas que se refieren a aplicaciones especí fi cas. Cuando la
necesidad de interpretaciones se pone en conocimiento del IEEE, el Instituto iniciará acción para preparar las respuestas adecuadas. Dado que los estándares de IEEE
representan un consenso de los intereses involucrados, es importante asegurarse de que cualquier interpretación ha recibido también la concurrencia de un equilibrio de
intereses. Por esta razón, IEEE y los miembros de sus sociedades y comités de coordinación de las normas no son capaces de proporcionar una respuesta inmediata a las
solicitudes de interpretación, excepto en aquellos casos en que el asunto ha recibido previamente el examen oficial.

Comentarios de la revisión de los estándares de IEEE son bienvenidos de cualquier parte interesada, independientemente de la pertenencia a fi liación con los estándares IEEE.

Sugerencias para cambios en los documentos deben estar en la forma de una propuesta de cambio de texto, junto con las observaciones de apoyo adecuados. Los comentarios sobre las

normas y las solicitudes de interpretaciones deben dirigirse a:

Secretario, IEEE-SA Standards Board 445 Hoes

Lane,
PO Box 1331 Piscataway, NJ 08855 a
1331 EE.UU.

Nota: Se llama la atención a la posibilidad de que la aplicación de esta norma puede requerir el uso de la materia cubierta por derechos de patente. Por
la publicación de esta norma, no posición se toma con respecto a la existencia o validez de los derechos de patentes en relación con la misma. El IEEE
no será responsable de identificar las patentes para las que una licencia puede ser requerido por un estándar IEEE o para la realización de
investigaciones sobre la validez jurídica o el alcance de las patentes que se señalan a su atención.

El IEEE y sus designados son los únicos entidades que podrá autorizar el uso de las marcas de propiedad de IEEE Certificación y / o marcas para indicar el cumplimiento con los
materiales establecidos en este documento.

La autorización para fotocopiar partes de cualquier norma específica para el uso interno o personal es otorgada por el Instituto de Ingenieros Eléctricos y Electrónicos,
Inc., a condición de que la tarifa correspondiente se paga al Copyright Clearance Center. Para arreglar el pago de la cuota de licencia, por favor, póngase en contacto
con Copyright Clearance Center, Servicio al Cliente, 222 Rosewood Drive, Danvers, MA 01923 EE.UU.; 1 978 750 8400. El permiso para fotocopiar porciones de
cualquier norma individual para uso educacional clase también se puede obtener a través del Copyright Clearance Center.
Introducción

(Esta introducción no es parte de IEEE Std 1063-2001, IEEE estándar para el software de documentación del usuario.)

Hay dos factores que motivaron el desarrollo original de esta norma en 1987: la preocupación de las comunidades de usuarios de software por la mala
calidad de la documentación de usuario mucho, y la necesidad de requisitos expresados ​por los productores de la documentación. Desde su aprobación,
IEEE Std 1063-1987 ha visto un amplio uso en la preparación de manuales de usuario impresos y ha contribuido a la mejora de la calidad de la
documentación.

Debido a la prevalencia de la ayuda en línea y documentación de usuario en formato electrónico, la norma ha sido completamente revisada para
abordar tanto la documentación de usuario impresa y electrónica.

La documentación del usuario que se ajusta a esta norma también se ajustará a los requisitos de una descripción documentación del
usuario según lo prescrito por IEEE / EIA 12207,1-1997. En particular, los requisitos de subcláusulas 5.1 y 6.30 de esa norma serían
satisfechas.

Al inicio de la planificación de la documentación, el software, las interfaces de usuario y las tareas que realizan los usuarios con el software debe ser
identi fi cado. documentación del usuario éxito es el resultado de la audiencia adecuada identificación, software reflexivo y diseño de documentos, y el
buen estilo de escritura, además de la estructura, el contenido y los requisitos de formato tratados por esta norma. La prueba definitiva de la
documentación de usuario del software es que es fácilmente utilizable por el público objetivo para el fin previsto.

En el momento en que se completó estándar, el grupo de trabajo tuvo los siguientes miembros:

Annette D. Reilly, Silla

Philip Bernick, Secretario

Selim Aissi Bill Albing Jeanette Evans Carl-Heinz Mark L. Levinson Dana
Smokey Bare Carsten Gabriel Michael Graham B. Mackonis Joan
Behrens John Bell Johannes Graubner Michaeli Alma Nahigian
Janean Bowen Janice Gertrud Grünwied Karl A. Elizabeth L. Reed Elmar
Carlson Giovanna Hakkarainen Clyde Hatter Roberg Ann Rockley
Chiozzi Phil Cohen George F. Hayhoe Ralph Roberta A. Rupel Lina
Scott DeLoach Yvette Hornbeck Joel Howard Scorza Subrato
Duncan Verna Dunn Holly Jahangiri Jacques Sensharma Elna R.
Miriam Eldridge LeCavalier Robert Tymes de Dave Dave
Lessman Whelan Versdahl

Copyright © 2001 IEEE. Todos los derechos reservados. iii

Las siguientes personas estaban en el comité de votación:

Theodore K. Atchinson Eva Freund Andrew Gabb James W. Moore Francisco

Edward E. Bartlett Barbara K. Barry L. Garner Gregg Navas Plano Alexander J.
Beauchamp Richard E. Biehl Giesler Julio Gonzalez Polack Annette D. Reilly
Juris Borzovs Kathleen L. Sanz-Lewis Gray
Briggs Joseph Butchko R. Waldo Roth Terence P.
Edward R. Byrne Keith Keith Rout Helmut Sandmayr
Chan Chow Antonio M. Cicu LM Gunther George F. Frederico Sousa Santos
Sylvain Clermont Francois Hayhoe Rick James H. Robert J. Schaaf Norman
Coallier Rosemary Coleman Hefner Heil Mark Heinrich Schneidewind David J. Schultz
Paul R. Croll Gregory T. Mark O. Henley Debra Subrato Sensharma Robert W.
Daich Taz Daughtrey Bostjan Herrmann John W. Horch Robert Shillato Spillers Fred J.
K. Derganc Perry R. Peter L. Hung George Strauss Toru
DeWeese Franz D. Jackelen Neil G. Jacobson Takeshita-Marcos René
Engelmann William Eventoff Thomas M. Kurihara Uchida Glenn D. Scott A.
John W. Forster Fendrich Venables Whitmire Paul AT
Julian John H. Fowler Wolfgang Paul R. trabajo Don
Wright Natalie C. Yopconka
Geraldine Zimmerman
J. Dennis Lawrence Jim J.
Logan John Magee Señor
Stan Tomoo Matsubara
Ian R. McChesney Denis
C. Meredith

Cuando el Consejo de Normas IEEE-SA aprobó esta norma el 5 de diciembre de 2001, tenía los siguientes miembros:

Donald N. Heirman, Silla

James T. Carlo, Vicepresidente

Judith Gorman, Secretario

Satish K. Aggarwal Mark James H. Richard J. Gurney James W. Moore Robert

D. Bowman Gary R. Holleman Lowell G. Johnson F. Munzner Ronald C.
Engmann Harold E. Robert J. Kennelly Joseph L. Petersen Gerald H.
Epstein Koep para los dedos * Peter H. Peterson John B. Posey
H. Landis Floyd Jay Labios Gary S. Robinson Akio
Forster * Howard M. Tojo Donald W. Zipse
Frazier Ruben D. L. Bruce McClung
Garzon Daleep C. Mohla

* miembro Emérito

También se incluye el siguiente enlace sin derecho a voto Consejo de Normas IEEE-SA:

Alan Cookson, Representante del NIST

Donald R. Volzka, TAB Representante

Catalina KN Berger
Andrew D. Ickowicz
Editores de proyecto IEEE Normas

iv Copyright © 2001 IEEE. Todos los derechos reservados.

Contenido

1. Visión de conjunto................................................. .................................................. ........................................... 1

1.1 Alcance ................................................ .................................................. .......................................... 1

1.2 Propósito ................................................ .................................................. ....................................... 1

1.3 Organización de la norma ............................................. .................................................. ......... 1

1.4 Candidato utiliza ............................................... .................................................. ............................ 2

2. Definiciones ................................................. .................................................. ......................................... 2

3. Estructura de la documentación de usuario del software ............................................. .............................................. 3

3.1 Estructura general de la documentación ............................................. ................................................ 4

3.2 componentes iniciales ............................................... .................................................. ....................... 5

3.3 Colocación de la información crítica ............................................. .................................................. 5 ..

4. contenido de información de la documentación de usuario del software ............................................ .............................. 5

4.1 Integridad de la información .............................................. .................................................. ....... 6

4.2 Exactitud de la información .............................................. .................................................. .............. 6

4.3 Contenido de los datos de identificación ............................................. .................................................. ........ 6

4.4 Información para el uso de la documentación ........................................... ........................................ 7

4.5 Concepto de operaciones .............................................. .................................................. .................. 7

4.6 Información para el uso general del software .......................................... ....................................... 7

4.7 Información para los procedimientos y tutoriales ............................................ ......................................... 7

4.8 La información sobre los comandos de software ............................................. ............................................... 8

4.9 Información sobre los mensajes de error y resolución de problemas .......................................... .................... 8

4.10 Información sobre la terminología .............................................. .................................................. ........ 8

4.11 La información sobre fuentes de información relacionadas ............................................ .................................... 8

5. Presentación de la documentación de usuario del software ............................................. ................................................. 9

5.1 La consistencia de la terminología y formatos ............................................ ......................................... 9

5.2 El uso de formatos impresos o electrónicos ........................................... ................................................. 9

5.3 Legibilidad ................................................ .................................................. .................................. 10

5.4 Formatos para las advertencias, precauciones y notas ......................................... ........................................ 10

5.5 Formato de las instrucciones .............................................. .................................................. ............... 10

5.6 Formatos para la representación de elementos de la interfaz de usuario ........................................... ........................... 11

5.7 Formatos para funciones de documentación para acceder a la información .......................................... ...... 11

5.8 Formatos para funciones para navegar ............................................ ................................................ 12

5.9 Formatos para ilustraciones .............................................. .................................................. ............. 13

Anexo A Bibliografía (informativo) ............................................ .................................................. ........... 14

Anexo B (Informativo) Nota de la documentación de usuario del software ......................................... ........................ 15

Índice ..................................................................................................................................................... . dieciséis

Copyright © 2001 IEEE. Todos los derechos reservados. v

IEEE estándar para el software de documentación
del usuario

1. Información general

En esta cláusula se presenta el alcance, propósito, organización, y el candidato utiliza de esta norma.

1.1 Alcance

Esta norma establece los requisitos mínimos para la estructura, el contenido de la información, y el formato de documentación para el usuario, tanto de
documentos impresos y electrónicos que se utilizan en el entorno de trabajo de los usuarios de los sistemas que contienen software. Esta norma se limita a
la documentación del producto de software y no incluye los procesos de desarrollo o la gestión de la documentación de usuario del software; se aplica a los
manuales impresos de usuario, ayuda en línea y documentación de referencia para el usuario. No se aplica a los materiales del curso especializados
destinados principalmente para uso en programas de capacitación formal.

Esta norma está destinada ni a alentar ni desalentar el uso de los medios de comunicación, ya sea impresa o electrónica (en línea) para la documentación, o
de cualquier desarrollo de la documentación en particular o herramientas o metodologías de gestión. Los usuarios de esta norma pueden querer desarrollar un
manual de estilo para su uso dentro de sus propias organizaciones para complementar las pautas establecidas en la norma, o de adoptar una guía de estilo
reconocido por la industria. Los usuarios de esta norma también pueden querer realizar pruebas de usabilidad en la documentación de usuario del software.
Las obras citadas en la bibliografía proporcionan orientación sobre los procesos de gestión, preparación y prueba de la documentación del usuario (ver Anexo
A).

1.2 Propósito

Esta revisión proporciona los requisitos para la estructura, el contenido de la información, y el formato de ambos documentación impresa y electrónica.
Se ocupa de los intereses de los adquirentes de software, fabricantes y usuarios en las normas para la documentación consistente, completa, precisa y
utilizable.

1.3 Organización de la norma

Después de la Cláusula 2, esta norma está organizada de acuerdo con los diferentes aspectos de la documentación de usuario: estructura (Cláusula 3), de
contenido de información (cláusula 4), y el formato (cláusula 5). En cada cláusula, los requisitos son independiente del medio, en la medida de lo posible.
Requisitos especí fi cos a su impresión o medios electrónicos se identifican como tales, en particular en la Cláusula 5. El orden de cláusulas en esta norma
no implica que la documentación de usuario del software debe ser desarrollado en este orden o presenta al usuario en este orden.

Copyright © 2001 IEEE. Todos los derechos reservados. 1

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

1.4 usos candidatos

La redacción de cada cláusula en esta norma ayuda a quienes tengan la intención con la reivindicación conformidad con la norma. El termino deberá identi
fi ca los requisitos obligatorios para exigir la conformidad con esta norma. El termino debería
identi fi ca un enfoque que se recomienda, pero no es necesario, para exigir la conformidad con esta norma. El termino mayo identi fi ca un
enfoque que está permitido dentro de los límites de la norma, pero no se requiere para exigir la conformidad con esta norma.

Esta norma puede ser incluido o se hace referencia en los contratos o acuerdos similares cuando las partes (llamado el adquirente y el productor o
proveedor) de acuerdo en que el proveedor entregará la documentación de conformidad con la norma. Esta norma también puede ser adoptado como un
estándar en el local por un proyecto u organización que decide producir la documentación de conformidad con la norma. Aunque esta norma está
destinada a la documentación del software para los usuarios finales, que se puede aplicar a la documentación producida por los operadores de
computadoras o administradores de sistemas que no son los usuarios finales.

Este estándar está destinado a ser adaptado de manera que sólo se aplican requisitos necesarios y rentables. La adaptación puede tomar la
forma de especificar enfoques para cumplir con sus requisitos obligatorios, o alterar sus recomendaciones no obligatorias y enfoques para reflejar
el producto de software y documentación particular, de manera más explícita. Adaptación de las decisiones tomadas por el adquirente debe ser
especificados en el contrato.

2. Definiciones

A lo largo de esta norma, el término documentación se refiere a la documentación de usuario del software. El uso de la terminología en esta
norma es para facilitar la referencia y no es obligatorio para la conformidad con la norma. A los efectos de esta norma, se aplican los siguientes
términos y de fi niciones. IEEE 100, El Diccionario de autoridad de estándares IEEE Términos , Séptima edición [B9] 1 , Se debe hacer referencia a
términos no se define en esta cláusula.

2.1 Medida: Elemento de un paso que un usuario realiza para completar un procedimiento.

2.2 precaución: Asesor en la documentación del usuario de software que realizar algún tipo de acción puede llevar a consecuencias que no son deseados o
inde fi nida, como la pérdida de datos o problemas en el equipo. ( Ver también: advertencia
y Nota .)

2.3 información crítica: La información sobre el uso seguro del software, la seguridad de la información creada con el software, o la
privacidad de la información creada por o almacenados con el software.

2.4 conjunto de documentos: Una colección de la documentación que se ha segmentado en volúmenes fi cados por separado identi o productos para facilitar
la distribución y el uso.

2,5 ilustración: elemento gráfico separado del cuerpo principal del texto y, normalmente, citado en el texto principal. En esta norma, el término ilustración
se utiliza como término genérico para las tablas, figuras, exposiciones, capturas de pantalla, gráficos de fluencia, diagramas, dibujos, iconos y otros
elementos gráficos.

2.6 Modo de enseñanza: modo de uso que se pretende enseñar el uso de software en la realización de tareas.

2.7 nota: Consejos útiles (s) y otra información que pueda ayudar al usuario, al subrayar y que complementa puntos importantes del texto principal.
( Ver también: advertencia y precaución .)

2.8 Procedimiento: serie de pasos que un usuario sigue para hacer una o más tareas ordenada.

1 Los números entre paréntesis corresponden a los de la bibliografía en el anexo A.

2 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

modo de 2.9 referencia: modo de uso que se pretende proporcionar un acceso rápido a la información específico para los usuarios de software que por lo general

están familiarizados con las funciones del software.

producto de software 2.10: Uno o más programas informáticos así como los puntos no electrónicos auxiliares que se acompañan, no mecánicos
tales como documentación y hojas de trabajo, entregadas bajo un único nombre para su uso por otros.

documentación del usuario de software 2.11: cuerpo electrónica o impresa del material que proporciona información a los usuarios del software.

2,12 paso: Un elemento de un procedimiento. Un paso contiene una o más acciones.

2.13 estilo: Conjunto de convenciones editoriales que cubren la gramática, terminología, puntuacion, uso de mayúsculas, y el diseño de un documento de usuario

del software.

2.14 tutorial: procedimiento de instrucción en el que el usuario ejerce funciones de software que utilizan datos de ejemplo que se suministran con el software o la
documentación.

Modo 2.15 uso: de manera primaria en la que el emisor del documento espera que el documento que se utilizará. Esta norma reconoce dos
modos de uso: instrucción y referencia.

2.16 usuario: Persona que emplea el software para realizar una tarea.

2.17 advertencia: Asesor en la documentación del usuario de software que realizar algún tipo de acción puede llevar a consecuencias graves o peligrosas. ( Ver
también: precaución y Nota .)

3. Estructura de la documentación de usuario del software

La estructura de la documentación de usuario del software, tanto en formato impreso y electrónico, incluye la forma en que está organizada en segmentos y
en qué orden los segmentos se presentan. La documentación puede ser estructurado en un único documento o un conjunto de documentos de documentos
impresos y / o electrónicos. La estructura de la documentación de usuario del software debe ayudar al usuario a localizar y comprender el contenido de
información. Cuando un conjunto de documentos se dirigirá al público con necesidades muy diferentes, al menos una de las siguientes estructuras se
utilizarán:

- secciones separadas dedicadas a las necesidades de las audiencias específicas. Las audiencias y sus necesidades deben ser identi fi cado

específicamente en la introducción, que permite a cada usuario identificar las secciones de interés.

- documentos separados o conjuntos de documentos para cada audiencia específica.

La Tabla 1 enumera obligatorios y opcionales estructural, el contenido y los componentes de formato del documento. Los componentes pueden estar
dispuestos en este orden en la documentación impresa. Los componentes necesarios se incluirán en la documentación de usuario del software a menos
que la información no existe o no es aplicable para un documento específico. Por ejemplo, una descripción de las convenciones puede no ser aplicable
en un documento general. Los componentes pueden ser renombrados; por ejemplo, la información sugiere para la introducción podría ir en una sección
denominada “Prefacio”.

Copyright © 2001 IEEE. Todos los derechos reservados. 3

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

Tabla 1-componentes de la documentación de usuario del software

ver
Componente ¿Necesario?
subcláusula

datos de identificación (paquete de página de etiquetas / title) 4.3 Sí

Tabla de contenido 5.7.1 Sí, en los documentos de más de ocho páginas a continuación de los
datos de identi fi cación

Lista de Ilustraciones 5.7.2 Opcional

Introducción 3.2 Sí

Información para el uso de la documentación 4.4 Sí

Concepto de operaciones 4.5 Sí

procedimientos 4.6, 4.7 Sí (modo de instrucción)

La información sobre los comandos de software 4.8 Sí (modo de referencia)

Los mensajes de error y resolución de problemas 4.9 Sí

Glosario 4.10 Sí, si la documentación que contiene los términos desconocidos

fuentes de información relacionados 4.11 Opcional

funciones de navegación 5.8 Sí

Índice 5.7.3 Sí, en los documentos de más de 40 páginas

capacidad de búsqueda 5.7.4 Sí, en los documentos electrónicos

3.1 Estructura general de la documentación

Un conjunto de documentos puede consistir en uno o más documentos, y cada documento de un conjunto de documentos puede ser uno o más
volúmenes. Por ejemplo, un manual de comando impreso podría tener un volumen que cubre la mitad de los comandos y un segundo volumen que cubre
la otra mitad de los comandos.

Los documentos se estructuran en unidades con un contenido único. documentación bien estructurada facilita información donde
se necesita sin redundancia.

Para los propósitos de esta norma, la siguiente nomenclatura no obligatorio se utiliza para las partes estructurales de la documentación de usuario del
software. Un documento impreso se estructura en unidades lógicas llamadas capítulos , subdividido en temas , que puede estar subdividido en subtemas , e
impreso en unidades físicas llamadas páginas . Un documento electrónico se estructura en unidades lógicas llamadas temas y presentado en unidades
físicas llamadas páginas o
pantallas . Debido a las variaciones entre dispositivos de visualización físicos, el término pantalla tal como se utiliza aquí no se refiere necesariamente a la
material que se muestra al usuario en un solo instante, sino más bien a toda la colección de material disponible por las operaciones de desplazamiento simples.
Cada página o pantalla estarán etiquetados de forma única (por ejemplo, con un número de página o tema o nombre de usuario o número). Cuando se ve o
impreso, cada tema en un documento electrónico debe ser identificado como perteneciente a poder el documento principal. Por ejemplo, una barra de estado o
de cabecera muestra el documento o nombre de archivo.

Los documentos impresos serán estructuradas con no más de tres niveles de la subdivisión de un capítulo. Por ejemplo, un subtema numerada
1.2.3.4 estaría en el nivel más bajo de la subdivisión. Los documentos electrónicos serán estructuradas de manera que la información se puede
acceder con no más de tres saltos (links) en la página inicial de un tema (sin contar cualquier acción necesaria para abrir el documento).

4 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

La estructura de la documentación, la duración de un capítulo o tema, y ​la cantidad de información que se presenta en una página o pantalla (unidad física)
depende de varias consideraciones:

- El acceso a la documentación al utilizar el software

- Cantidad de información
- familiaridad con la información de la audiencia
- Las limitaciones de los medios

- modos de uso

La organización de la documentación apoyará su modo de uso ( instructivo o referencia ). Cuando un documento contiene tanto
material de instrucción y de referencia, los dos estará claramente separada en diferentes capítulos o temas, o distingue por el
formateo en el capítulo o tema.

Tarea orientada el modo de instrucción documentación incluirá procedimientos estructurados de acuerdo a las tareas del usuario. Tareas relacionadas deben
agruparse en el mismo capítulo o tema. Capítulos y temas deben ser organizados para facilitar el aprendizaje mediante la presentación de las tareas más
simples, más comunes, o iniciales ante más compleja, menos utilizado, o las tareas posteriores.

modo de referencia documentación debe estar dispuesto para facilitar el acceso aleatorio a las unidades individuales de información. Por ejemplo, una
lista de comandos de software o mensajes de error debe ser ordenada alfabéticamente.

3.2 componentes iniciales

Cada documento individual deberá ser estructurado para comenzar con los datos de identi fi cación (véase 4.3), seguido de una tabla de
contenidos (véase 5.7.1) y una introducción; es decir, la introducción es el primer capítulo fi o tema del documento. La introducción debe
describir el público objetivo, alcance y finalidad del documento e incluir una breve descripción de la finalidad del software, las funciones y el
entorno operativo.

Introducciones se presentará dentro de un documento para cada capítulo y tema. secciones introductorias se debe proporcionar para cada
característica o función del software principal siendo documentados. Las secciones introductorias de proporcionar una visión general del tema, el
propósito de la función, y cualquier requisito, advertencias, precauciones o las necesidades del usuario únicas del medio ambiente con el tema.

3.3 Colocación de la información crítica

La información crítica debe ser colocado en un lugar prominente en la documentación. advertencias o precauciones generales que se aplican en el
uso del software o de la documentación deberán aparecer en los componentes iniciales. advertencias y precauciones fi cas deberán aparecer en la
misma página o pantalla e inmediatamente antes del procedimiento o etapa que requiere atención.

4. Contenido de la información de la documentación de usuario del software

características Esta cláusula especificidad es de información contenida en la documentación del usuario (ver 4.1 y 4.2), incluyendo la integridad y
exactitud. Esta cláusula también define la información requerida para su inclusión en la documentación del usuario (ver 4.3 a través de 4.11). La
información requerida en esta cláusula se incluirá en la documentación de usuario del software a menos que la información no existe o no es aplicable
para un documento específico.

El contenido de la documentación está relacionada con su modo de uso. Los usuarios del software necesitan documentos ya sea para aprender acerca del
software ( el modo de instrucción ) o para refrescar su memoria respecto ( modo de referencia ). documentos modo de instrucción pueden ser detallada o orientado
a la tarea. Los documentos de información orientado a instruir al usuario sobre los conceptos y la información técnica necesaria para utilizar el software
correctamente (véase 4.5). Tarea orientada

Copyright © 2001 IEEE. Todos los derechos reservados. 5

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

documentos muestran al usuario cómo llevar a cabo los procedimientos para alcanzar una meta (véase 4.6). documentación modo de referencia puede ser
sensible al contexto y integrado en el software, por ejemplo, pop-up o listas desplegables de valores de datos aceptables o comandos. En cualquiera de
documentación de instrucción o de referencia, el contenido de la documentación se puede mejorar mediante la inclusión de ejemplos e ilustraciones.

4.1 Integridad de la Información

La documentación debe proporcionar instrucciones y la referencia completa de todas las funciones críticas de software (software cuyo fallo podría tener
un impacto en la seguridad, o podría causar grandes fi nanciera o pérdida social). documentación modo de instrucción incluirá información completa
para permitir el desempeño de las tareas seleccionadas utilizando las funciones del software por los miembros con menos experiencia de la audiencia.
documentación modo de referencia deberá incluir todas las instancias de los elementos seleccionados se documentan. Por ejemplo, si la
documentación modo de referencia cubre un subconjunto de comandos de software, que incluirá todas las órdenes y systemdisplayed introducidos por
el usuario y mensajes de error en ese subconjunto.

4.2 Exactitud de la información

La documentación debe volver a reflejar con precisión las funciones y resultados de la versión del software de aplicación. Si la versión de la documentación
anterior ya no es preciso, la nueva documentación estará disponible con las actualizaciones de software o actualizaciones. correcciones de documentación y
actualizaciones se pueden ofrecer a través de un nuevo manual, una lectura que me fi l o fe de erratas, o una descargados fi l de un sitio web.

4.3 Contenido de los datos de identi fi cación

La documentación debe contener datos únicos de identi fi cación. Los datos de identi fi cación incluirán lo siguiente:

a) Título de documentación
b) Versión de la documentación y la fecha publicados
do) producto de software y la versión
re) Organización emisora

los datos de identi fi cación deberán figurar en una etiqueta del paquete, legible sin necesidad de abrir el paquete, y en una página de título. Una etiqueta del

paquete no es necesario si la portada es legible sin necesidad de abrir el paquete. Cada documento en un conjunto de documentos tendrá una página única título.

Para los documentos de una sola página, tales como tarjetas de referencia rápida, los datos de identificación puede aparecer en la misma página que el resto del

documento.

El título del documento debe indicar su naturaleza y alcance, y no debe incluir abreviaturas o acrónimos a menos que sean familiares
para el público objetivo. Si diferentes versiones del software están disponibles para diferentes entornos de funcionamiento, la página
del título debe especificar el entorno operativo aplicable (s), incluyendo la versión (s) de hardware, comunicaciones y sistema (s)
operativo. Otra información, incluyendo documentos o números de piezas de productos de software, números de serie, y restricciones
de uso, puede incluirse en la etiqueta del paquete y en la primera página o páginas siguientes. La etiqueta del envase y las páginas
inmediatamente posteriores a la página del título debe incluir los derechos de autor y marcas de avisos, restricciones sobre la copia o
distribución de la documentación, la información para comunicarse con la organización emisora ​(comentarios del lector), garantías,

La identificación del documento y el software deberá ser consistente con las prácticas de gestión con fi guración de la organización
emisora ​o la organización compradora. Información (cambiar la historia) se facilitará en el documento establecido para documentar la
fecha de emisión y número de versión de la versión actual y cada versión previa de la documentación.

6 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

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

La documentación deberá incluir información sobre la forma en que se va a utilizar (por ejemplo, ayudar a la ayuda), y una explicación de la notación (una
descripción de formatos y convenciones-ver 5.8). Al menos un documento en un conjunto de documentos deberá identificar todos los documentos en el
conjunto por título y el uso previsto, incluyendo recomendaciones sobre la que los miembros de la audiencia deben consultar las secciones de la
documentación. En los conjuntos de documentos que comprenden muchos volúmenes o productos, esta información puede ser proporcionada en una “hoja
de ruta” separada o guía para el conjunto de documentos. La documentación puede incluir la identi fi cación y discusión de los cambios notables a la versión
anterior del conjunto de documentos y software.

4.5 Concepto de operaciones

La documentación debe explicar la base conceptual para el uso del software, usando métodos tales como una descripción visual o verbal del
proceso o flujo de trabajo; o la teoría, lógica, los algoritmos, o el concepto general de la operación. Explicaciones del concepto de operación deben
adaptarse a la familiaridad esperado de los usuarios con cualquier terminología especializada para tareas de usuario y las funciones del software.
La documentación debe relacionar cada función que se ha documentado el proceso general o tareas. Información conceptual se puede presentar en
una sección o inmediatamente precedente a cada procedimiento aplicable.

4.6 Información para el uso general del software

documentación modo de instrucción orientado a la tarea incluirá instrucciones para actividades de rutina que se aplican a varias
funciones:

- Instalación de software y de-instalación, si se realiza por el usuario

- Orientación al uso de las características de la interfaz gráfica de usuario (ver 5.6)
- Acceso o conexión a la comunicación y el cierre de sesión del software

- Navegación a través del software para acceder y salir de las funciones

- operaciones de datos (introducir, guardar, leer, imprimir, actualizar y eliminar)

- Métodos de cancelar, interrumpir y reiniciar las operaciones

Estos procedimientos comunes deben presentarse una vez para evitar la redundancia cuando se utilizan en las funciones más complejas.

4.7 Información para los procedimientos y tutoriales

documentación modo de instrucción proporciona instrucciones para la realización de procedimientos. Las instrucciones incluirán información preliminar, las
medidas de instrucción, y la información de finalización.

La información preliminar comunes a varios procedimientos pueden agruparse y se presentó una vez para evitar la redundancia. La información
preliminar para obtener instrucciones deberá incluir lo siguiente:

- Una breve descripción de la finalidad de las definiciones y procedimientos de fi o explicaciones de los conceptos necesarios no comprendidos en otra
parte
- La identificación de las actividades técnicas o administrativas que se debe hacer antes de iniciar la tarea
- Una lista de los materiales que el usuario necesitará para completar la tarea, que puede incluir datos, documentos, contraseñas, software
adicional, y la identi fi cación de los conductores, interfaces o protocolos
- advertencias pertinentes, precauciones y notas que se aplican a todo el procedimiento

Copyright © 2001 IEEE. Todos los derechos reservados. 7

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

advertencias pertinentes, precauciones y notas precedan inmediatamente a cada paso de instrucción aplicable o grupo de pasos. medidas de instrucción
deberán utilizar el modo imperativo para la acción del usuario. medidas de instrucción deberán indicar la respuesta o resultado esperado del sistema. pasos
de Instrucción deberán incluir o proporcionar referencias a la documentación del rango aceptable, la longitud máxima y formato aplicable, y unidad de medida
de campos de datos para los datos suministrados por el usuario. formatos y valores de datos aceptables comúnmente se documentan a través de las listas de
pop-up. medidas de instrucción deberán incluir o proporcionar referencias a las explicaciones de los mensajes de error y los procedimientos de recuperación.

medidas de instrucción se presentarán en el orden de actuación. Procedimientos alternativos o repetidas deben estar claramente indicados, por lo que el
usuario puede determinar que se alternan o etapas repetidas para llevar a cabo o se saltan y donde para reunirse con el procedimiento principal.

información de finalización para obtener instrucciones, indicarán quién es el último paso en el procedimiento, como el usuario puede
determinar si el procedimiento se ha completado con éxito, y cómo el usuario debe salir del procedimiento.

4.8 La información sobre los comandos de software

La documentación debe explicar los formatos y procedimientos para los comandos de software introducidos por el usuario, como los parámetros
requeridos, los parámetros opcionales, opciones por defecto, el orden de los comandos y sintaxis. La documentación puede ser proporcionada en el
desarrollo y mantenimiento de macros y scripts. documentación modo de referencia deberá incluir una referencia de todas las palabras o comandos
reservados. Los ejemplos deben ilustrar el uso de comandos. La documentación debe explicar cómo interrumpir y deshacer la operación durante la
ejecución de un comando y cómo reiniciarlo, si es posible. Documentación describirá cómo reconocer que el comando se ha ejecutado
correctamente o terminado anormalmente.

4.9 Información sobre los mensajes de error y resolución de problemas

La documentación debe abordar todos los problemas conocidos en el uso del software en su fi ciente detalle de tal manera que los usuarios
pueden recuperarse de los problemas por sí mismos o claramente reportar el problema al personal de soporte técnico. documentación modo de
referencia incluirá cada mensaje de error con una identi fi cación del problema, la causa probable, y las acciones correctivas que el usuario debe
tomar. Una tarjeta de referencia rápida puede dirigir mensajes de error al referirse al usuario la documentación de referencia más detallada. La
documentación sobre la resolución de problemas también incluirá información de contacto para reportar problemas con el software o su
documentación y sugerir mejoras.

4.10 Información sobre la terminología

La documentación debe incluir un glosario, si liquidación ni en su específico utiliza en la interfaz de usuario del software o la documentación son
susceptibles de ser desconocido para el público. El glosario incluirá una lista alfabética de términos y de fi niciones. Documentación uso de
abreviaturas y acrónimos poco familiar para el público deberá incluir una lista con las de fi niciones, que pueden ser integrados con el glosario. Los
términos incluidos en el glosario también deben definirse en su primera aparición en la documentación impresa. documentación electrónica puede
incluir enlaces de los términos a los glosarios o explicaciones en las ventanas secundarias.

4.11 La información sobre las fuentes de información relacionados

La documentación puede contener información sobre cómo acceder a fuentes relacionadas de información, como una bibliografía, lista de referencias o
enlaces a páginas web relacionadas. Otras fuentes de información y referencias pueden incluir los siguientes:

8 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

- Requisito especi fi caciones de diseño, las especificaciones y normas aplicables para el software y la documentación

- planes y procedimientos de prueba para el software y la documentación

- políticas de gestión con fi guración y procedimientos para el software y la documentación
- Documentación para el entorno de hardware y software
- Las explicaciones de los conceptos de operación o científica, o procesos de negocio técnico incorporado en el software.

La documentación debe indicar si las referencias contienen requisitos obligatorios o material de apoyo informativo.

5. Formato de la documentación de usuario del software

El formato de documentación incluye las convenciones de los medios de comunicación y presentación electrónica o impresión seleccionadas para elementos
estilísticos, tipográficos y gráficos. Esta cláusula formatos especí fi ca para diversos componentes de la documentación. El formato para la documentación modo
de referencia debe ser accesible y utilizable en el entorno de trabajo de los usuarios previstos. El tamaño de la documentación impreso y encuadernado
referencia, o equipo necesario, el espacio de almacenamiento electrónico, software de sistema operativo y navegadores para acceder a la documentación de
referencia en línea, deberá ser compatible con la capacidad del ambiente de trabajo de los usuarios previstos.

La documentación debe ser proporcionada en los medios y formatos que permitan su utilización por las personas con una visión, la audición, u otra
limitación física, si son capaces de utilizar el software y para realizar las tareas compatibles con el software. soporte de documentación y formatos
alternativos para los usuarios con limitaciones físicas pueden requerir software de adaptación especial y equipo no incluido en el software de
usuario o la documentación del software de usuario.

5.1 La consistencia de la terminología y formatos

La documentación debe utilizar una terminología coherente en todo el documento establecido para los elementos de la interfaz de usuario, elementos de
datos, los nombres de campo, funciones, páginas, temas y procesos. convenciones de formato para destacar la información de especial importancia, como
las advertencias, precauciones y notas, deberán aplicarse de manera coherente en todo el conjunto de documentos. La documentación puede utilizar un
formato especial para identificar el contenido nuevo o modificado. convenciones de formato pueden incluir colores, bordes, sangría, el espaciado y
variaciones de la fuente. material similar, tales como conjuntos de instrucciones, se presenta en un formato consistente.

Si la documentación está adaptada para su uso en otro entorno, el idioma o la cultura operativo, un glosario y comunes guías de estilo para el texto y las
ilustraciones deben ser utilizados para ayudar a los desarrolladores de documentación y traductores en el mantenimiento de la coherencia. Se debe
considerar a la selección de la terminología, ejemplos, gráficos y colores que no son cultura-específico, por lo que la documentación puede ser más
fácilmente adaptada, localizada, o traducido preservando al mismo tiempo el significado pretendido de la original.

5.2 El uso de formatos impresos o electrónicos

Sea o no se proporciona documentación electrónica, la siguiente documentación deberá ser presentada en forma impresa:

- Hardware, sistema operativo y software del navegador requisitos para el software y la documentación

- Información de la instalación, incluida la recuperación y solución de problemas para obtener instrucciones de instalación

- Las instrucciones para iniciar el software

Copyright © 2001 IEEE. Todos los derechos reservados. 9

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

- Las instrucciones para el acceso a la documentación electrónica

- Información para ponerse en contacto con el soporte técnico o la realización de acciones de recuperación disponibles para los usuarios

Una descripción de cómo imprimir la documentación electrónica debería incluirse tanto en la electrónica y la documentación impresa. Se debe proporcionar
un medio para la impresión de documentación en línea para los sistemas de software diseñados para su uso cuando está conectado a una impresora. El
sistema debe incluir características de software diseñadas para permitir la impresión de la documentación electrónica.

Documentación en línea estará disponible para su visualización en cualquier momento en el que es posible la entrada del usuario para el software. El
usuario debe ser capaz de realizar una función y lea la documentación en línea fi co-función específica relevante a la vez. El usuario debe ser capaz de ver
la documentación en línea y navegar a funciones de software relacionadas durante las operaciones del sistema.

5.3 La legibilidad

Documentación impresa y electrónica debe ser legible para el usuario, teniendo en cuenta la distancia entre el usuario y la documentación en el entorno
de trabajo esperada. La documentación debe utilizar un estilo de fuente y color que sea legible en el contexto esperado (el color del papel o color de
fondo de la pantalla). Documentación en línea deben permanecer legibles si el usuario es capaz de ampliar, reducir o cambiar la forma de la pantalla o
ventana. (todos los de capital) Las letras mayúsculas no se utilizarán para el texto continuo de más de 25 palabras. Texto, incluyendo el texto en las
ilustraciones, no deberá ser menor que 3 mm (aproximadamente 7,5 puntos).

Documentación en línea debe ser legible en el entorno de trabajo que se espera de los usuarios, que incluye la combinación prevista de monitor de la
computadora o controladores de gráficos de visualización y software. La legibilidad puede ser afectada por los dispositivos de salida (monitores e
impresoras) que son monocromo, tienen una resolución limitada, render colores diferente, o apoyar una gama limitada de colores. Algunos dispositivos de
salida pueden aplicar fuentes de sustitución o caracteres especiales si la fuente fi cado no está disponible. Distinciones que dependen más de dos
gradaciones de colores o tonos de gris pueden no ser visibles. Debido a que algunos usuarios no pueden distinguir entre los colores, la documentación
debe proporcionar indicaciones de texto en lugar de utilizar colores como el rojo y el verde como la única forma de transmitir significado.

5.4 Formatos para las advertencias, precauciones y notas

Advertencias, precauciones y notas se muestran en un formato consistente que es fácilmente distinguible del texto ordinario o los pasos de
instrucción. La palabra fl ag (por ejemplo, advertencia , precaución , o Nota ) precederá el texto que la acompaña. El termino Nota No se utilizarán
para identificar los peligros. Advertencias y precauciones serán identificados por símbolos gráficos y claras, por ejemplo, un signo de
exclamación o rayo dentro de un triángulo. Una advertencia o precaución deberán incluir las siguientes partes:

- la palabra de marcas

- Símbolo gráfico
- Breve descripción del riesgo
- texto de instrucciones sobre cómo evitar el peligro

- Consecuencias de incurrir en el peligro

- remedios del usuario de las consecuencias adversas, si los hay

5.5 Formato de las instrucciones

medidas de instrucción serán numeradas consecutivamente. Una convención de numeración o letras coherente debe establecerse para sub-etapas
o acciones, pasos alternativos y procedimientos repetidos.

10 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

5.6 Formatos para la representación de elementos de la interfaz de usuario

Interfaz gráfica de usuario (GUI) los elementos del software, tales como botones, iconos, cursores variables y punteros; usos especiales de las
teclas del teclado o combinaciones de teclas; y las respuestas del sistema se sustituirán en la documentación por los formatos gráficos o
tipográficos coherente, de modo que los diversos elementos se distinguen cada uno del texto. La documentación debe incluir una representación
del elemento, su propósito, y una explicación de su acción (consecuencia funcional), con ejemplos de casos reales de funcionamiento.
Documentación en línea puede incluir etiquetas de texto emergentes de elementos de la GUI.

formatos de documentación para los comandos introducidos por el usuario o códigos deberán distinguir claramente entre los literales (a introducir exactamente
como se muestra) y las variables (a ser seleccionados por el usuario). Las comillas no deben ser utilizados en las representaciones de comando a menos que el
usuario debe introducir de manera literal. La documentación debe abordar las variaciones en los teclados o dispositivos de entrada de datos en el entorno de
trabajo de los usuarios previstos.

5.7 Formatos para funciones de documentación para acceder a la información

La documentación debe contener características para proporcionar acceso a la información, incluyendo una tabla de contenidos; una lista de figuras, tablas o

ilustraciones; un índice; y capacidades de búsqueda electrónica.

5.7.1 Tabla de contenidos

Una tabla de contenido seguirá inmediatamente a los datos de identi fi cación (véase 4.3). La tabla de contenidos se deben enumerar los títulos de los capítulos o

temas de un documento con un punto de acceso para cada uno (su número de página inicial o un enlace electrónico). Documentos con menos de ocho páginas a

continuación de los datos de identi fi cación pueden omitir la tabla de contenido.

La tabla de contenido puede estar incompleta o simple. Un índice exhaustivo de todas las listas de títulos de los capítulos o temas (rúbricas) hasta el
tercer nivel. Una sencilla tabla de contenidos incluye sólo los títulos de nivel primero. Los documentos con una simple tabla de contenidos pueden
incluir tablas integrales secundarios de los contenidos que aparecen al principio de cada capítulo o tema, o accesibles a través de ventanas
emergentes, listas expandibles, o ventanas secundarias. documentación electrónica puede mostrar tablas de contenido en formatos extensible y
plegable para proporcionar alto nivel y acceso detallado a la partida sin desplazamiento excesivo. Al menos un volumen de un conjunto de documentos
deberá incluir una sencilla tabla de contenidos para todos los volúmenes en el conjunto.

La tabla de contenidos incluirá todas las porciones de la documentación, incluyendo la materia delantera que sigue a la tabla de contenido y la
espalda materia (por ejemplo, apéndices, glosario, y el índice). Los encabezados de la tabla de contenidos deberán ser idénticas en redacción a
los del documento, incluyendo números de capítulo o tema. El formato de la tabla de contenido deberá distinguir la jerarquía de las partidas por la
tipografía consistente o sangría. En la documentación impresa, la tabla de contenido deberá enumerar los títulos en el mismo orden que en el
texto. De la documentación electrónica, la tabla de contenido debe ordenar los encabezados de acuerdo a navegar secuencia, tarea, el tipo de
tema, u otros criterios lógicos.

5.7.2 Lista de ilustraciones

La documentación debe contener una lista de tablas, una lista de figuras, o una lista de ilustraciones (incluyendo ambas tablas y figuras) si el
documento contiene más de cinco ilustraciones numeradas y las ilustraciones no son visibles al mismo tiempo que las referencias de texto a ellos. La
lista de ilustraciones se deben enumerar los números de ilustración y títulos con un punto de acceso para cada uno (como su número de página inicial
o un enlace electrónico). Los títulos de la lista de tablas, figuras o ilustraciones deberán ser idénticas en redacción a los del documento, que incluye
una mesa, figura, o números de ilustración.

Copyright © 2001 IEEE. Todos los derechos reservados. 11

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

5.7.3 Índice

Un índice es una lista alfabética de palabras clave, gráficos, o conceptos con un punto de acceso para cada uno. Los documentos impresos más de 40
páginas incluirán un índice, cuyos puntos de acceso pueden ser números de página, los números de tema, números de ilustración, o referencias a otra
entrada de índice. Los documentos electrónicos más de 40 temas incluirán ya sea una herramienta de búsqueda (ver 5.7.4) o un índice cuyos puntos de
acceso son enlaces electrónicos. Anexo B proporciona una guía para la documentación de usuario de indexación. Una entrada de índice puede cruzar
referencia otra entrada de índice; Sin embargo, la entrada de referencia dará un punto de acceso a la documentación y no apuntar a una tercera entrada de
índice.

5.7.4 capacidad de búsqueda

documentación electrónica deberá proporcionar un método de localización de palabras en el texto. capacidades de búsqueda electrónicos pueden incluir la
búsqueda de texto completo del documento o conjunto de documentos; buscar palabras en las ilustraciones; búsqueda por palabra clave; hallazgo de una cadena
de texto en el tema actual; una búsqueda booleana; y la restricción de una búsqueda de capítulos especi fi cas, temas o páginas.

5.8 Formatos para funciones para navegar

Funciones para navegar incluyen capítulo y tema parte; página o pantalla títulos; números de capítulo, título, página, y la pantalla; pestañas; encabezados y
pies de página; marcadores; saltos (links); Referencias cruzadas; iconos de navegación; y botones. Características para la navegación deberán ser
proporcionados de manera que los usuarios pueden determinar su ubicación dentro del documento impreso o electrónico y todos los lugares a los que
pueden moverse de su ubicación actual. La documentación incluirá explicaciones de las funciones de navegación fi cos del sistema y de los documentos
especificados. En la documentación impresa, cada página debe tener un número de página única. En la documentación electrónica, cada página o pantalla
tendrá una única er identificado (alfanumérica y / o leyenda) accesible para el usuario. Las funciones de navegación deberán permitir a los usuarios de
documentación para ir a los lugares siguientes:

- Espalda , para volver a la sección / página más recientemente saltó de (vinculado)

- Siguiente, lógico siguiente tema / página en la secuencia de temas (si los hay)
- Anterior, lógica tema / página anterior a la que se está viendo (si los hay)
- Tabla de contenido ( si los hay)
- Índice ( si los hay)

Las funciones de navegación utilizarán formatos consistentes para la tipografía como enlaces subrayados, colores o gráficos para distinguirlos de texto
plano. Las funciones de navegación deben permanecer accesibles en una ubicación estática si la documentación electrónica permite desplazarse por el
texto.

Saltos (enlaces) proporcionarán una clara indicación del destino del enlace. Por ejemplo, utilice “Más sugerencias para solucionar problemas” en lugar de
“Haga clic aquí”. Los enlaces deben proporcionar la información que el usuario espera de un salto, en lugar de requerir un enlace a otro enlace que tiene
la información buscada. Si el destino está fuera de la documentación, la documentación debe proporcionar a los usuarios una forma alternativa de la
localización de la información, en caso de que el enlace se ha roto o el destino eliminado. Los vínculos entre los temas relacionados deberán ser
bidireccional, de modo que cualquiera que sea el tema a los usuarios acceder primero, pueden saltar a la información relacionada en el otro tema.

documentación modo de referencia electrónica será accesible desde los documentos de software de TI, y proporcionará un medio claro de la
salida de la documentación y volver al software. Software puede estar vinculado a la ayuda en línea, tutoriales, o documentación modo de
referencia en diversas formas, tales como las siguientes:

- A través de un menú de ayuda vinculada a una lista de temas o un punto de entrada al sistema de ayuda

- A través de los botones de ayuda en las pantallas del software que proporcionan información sobre un tema en particular (caja y el nivel de campo

ayuda de diálogo)

- A través de ayuda sensible al contexto y el texto emergente (información sobre herramientas)

12 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

5.9 Formatos para ilustraciones

Ejemplos que acompañan el texto deben aparecer junto a su primera referencia en el texto, por lo que el texto y la ilustración asociada se
pueden ver simultáneamente. En la documentación con más de cinco ilustraciones, cada ilustración debe tener un único número y título (ver
5.7.2). ilustraciones informales, que se refiere sólo una vez en el texto o tener ningún texto, pueden ser sin título y sin numerar.

El formato de ilustraciones de contenido similar será coherente de escala, tamaño de pantalla, fuentes, grosor de línea y el uso del color. En la documentación
electrónica, las ilustraciones deben ser de un tamaño que sean legibles y se podrá ver en su totalidad, sin necesidad de desplazarse, en el dispositivo de
visualización esperado. Considere simplificar o mostrar características sólo sobresalientes de un gráfico grande por lo que es visible a la vez sin tener que
desplazarse. mesas largas que no pueden encajar en una sola página deberán repetir el título de la tabla y los encabezados de columna o fila en cada página o
dos páginas. mesas largas que abarcan múltiples páginas también deben ser identi fi con un número de hoja, por ejemplo, “Tabla 15. Las unidades métricas (hoja
2 de 4)”.

Documentación que se destina para la impresión y distribución electrónica debe ser lógicamente completa, incluyendo ilustraciones y referencias a las
ilustraciones, en ambos medios. Se pueden necesitar un menor número de ejemplos en la documentación electrónica que permite enlaces a las
pantallas del software reales. Representaciones de elementos de la GUI en la documentación deben ser consistentes con la versión del software que se
está documentada.

Copyright © 2001 IEEE. Todos los derechos reservados. 13

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

Anexo A

(informativo)

Bibliografía

[B1] Brockmann, RJ, Escribiendo Documentación equipo mejor: del papel a hipertexto, John Wiley & Sons, Nueva York, 1990.

[B2] norma británica BS7649: 1993, Guía para el diseño y preparación de la documentación para los usuarios del software de aplicación.

[B3] norma británica BS7830: 1996, Guía para el diseño y preparación de la documentación en pantalla para los usuarios del software de
aplicación.

[B4] Dumas, JS, y rojizo, JC, Una Guía Práctica de pruebas de usabilidad, Rdo. ed., intelecto, 1999.

[B5] Hackos, JT, Administración de los proyectos de documentación, John Wiley & Sons, Nueva York, 1990.

[B6] Hackos, JT, y Stevens, DM, Normas de comunicación en línea: La publicación de información para Internet / World Wide Web /
Ayuda Sistemas / Internets corporativos, John Wiley & Sons, Nueva York, 1997.

[B7] Hackos, JT, y rojizo, JC, De usuario y análisis de la tarea de diseño de la interfaz, John Wiley & Sons, Nueva York, 1998.

[B8] Horton, W., El diseño y la documentación en línea de escritura: Hipermedia para los productos autoportantes,
2ª ed., John Wiley & Sons, Nueva York, 1994.

[B9] IEEE 100, El Diccionario de autoridad de estándares IEEE Términos, Séptima edición.

[B10] IEEE Std 610.12-1990, IEEE Standard Glosario de Terminología de Ingeniería de Software.

[B11] IEEE Std 1465-1998, Adopción IEEE Standard de la norma ISO / IEC 12119: 1994 (E) Standard- Internacionales de Información
Tecnología-requisitos de software Paquetes-calidad y pruebas.

[B12] IEEE / EIA 12207,1-1.997, Guía de implementación-Industria de la norma internacional ISO / IEC 12207: 1995 (ISO / IEC 12207) estándar
para los datos de ciclo de ciclo de vida Tecnología de la Información Software-procesos-Life.

[B13] ISO / IEC 15910: 1999, Tecnología de la información-Software proceso de documentación del usuario.

[B14] ISO / IEC TR 9294: 1990, Tecnología de la Información-Directrices para la gestión de la documentación del software.

[B15] Nagle, JG, Manual para la preparación de documentos de ingeniería: del concepto hasta su finalización, IEEE Press, Nueva York, 1996.

[B16] Price, J., y Korman, H., Cómo comunicar información técnica: Un Manual de Software y la documentación de hardware, Benjamin
/ Cummings, Redwood City, CA, 1993.

[B17] Schriver, KA, Dinámica de Documento de Diseño: Creación de textos para los usuarios, John Wiley & Sons, Nueva York, 1994.

14 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

anexo B

(informativo)

documentación de usuario del software de indexación

Un índice es un importante dispositivo de recuperación de información y debe ser construido de una manera que hace que sea fácil para los usuarios localizar la

información que buscan. En este anexo se ofrece orientación sobre las buenas prácticas para la documentación de usuario del software de indexación.

Use palabras que los usuarios puedan mirar hacia arriba y una lista de todos los temas en el documento. Minuciosamente la documentación de usuario del

software indexada puede tener de dos a cinco entradas por tema. Índice del prefacio, como apéndice, advertencias, precauciones y notas. En los documentos

electrónicos, índice de elementos no textuales como gráficos y multimedia.

Evitar palabras clave demasiado generales y el uso de términos descriptivos para las entradas, la colocación de la primera palabra principal. Por ejemplo, para el
título de texto, “Uso de gestor de archivo,” utilizar el título índice, “gestor de archivo, usando.” Entradas doble-post. Por ejemplo, el tema que aparece como “ahorro
de archivos” y “archivos, ahorrando” es de doble publicado. Utilizar sinónimos para proporcionar términos alternativos para el acceso.

Indicar la importancia de la información mediante la colocación de palabras clave de menor importancia en virtud de los principales. Romper las entradas que

tienen múltiples referencias en el documento en sub-entradas que indican qué aspecto del tema se trata. Utilice entradas primarias detalladas en lugar de entradas

secundarias o terciarias. Opcionalmente, identificar las principales referencias de página marcando el número de página en negrita.

Opcionalmente, para conjuntos de documentos, incluir un índice global, además de los índices en los volúmenes individuales. El índice global proporciona
a los usuarios con los medios de búsqueda de información en un solo índice, en lugar de mirar hacia arriba en los índices de los documentos individuales.
Dar referencias de localización para cada entrada que incluye una abreviatura del título del documento, además de los números de página.

Copyright © 2001 IEEE. Todos los derechos reservados. 15

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

Índice

UN

abreviaturas, 4,10 acceder a la

información, 5,7 exactitud, 4.2
acrónimos, 4,10 de acción, 2.1, 4.7 de
la audiencia, Cláusula 3

segundo

volver materia, bibliografía

5.7.1, Anexo A marcador, 5,8

do

mayúsculas, 5.3
precaución, 2.2, 3.3, 4.7, 5.4, capítulo Anexo B,
3.1 color, 5,3

de comandos, software, 4,8, 5,6 integridad de la

información, 4.1 concepto de las operaciones, la
cláusula 3, 4,5 consistencia, 5,1

contenido de la documentación, la cláusula 4 aviso

de copyright, 4.3 función crítica, la información
crítica 4.1, 2.3, 3.3 referencia cruzada, 5,8

re

de fi niciones, inciso 2
componentes documento, establezca la cláusula 3 del

documento, 2.4, Cláusula 3, 4.4, Anexo B

mi

ambiente. Ver ambiente de trabajo, los usuarios. Ver entorno operativo. fe de erratas, 4,2

mensaje de error, la cláusula 3, 4.9 de

exposiciones. Ver ilustración.

fi gura. Ver ilustración. fl ag

palabra, 5,4 fuente, 5.3 pie de

página, 5,8

dieciséis Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

formato, 5.8 páginas

preliminares, 5.7.1 función,
crítico, 4,1

GRAMO

glosario, la cláusula 3, 4,10

interfaz gráfica de usuario (GUI), 5,6, 5,9 gris, 5,3
verde, 5,3

MARIDO

peligro, 5,4
cabecera, 5,8
título, 5,8 ayuda,
4.4, 5.8

yo

icono, 5.6, 5.8

datos de identificación, la cláusula 3, 3.2, 4.3
ilustración, 2.5, 5.9 ilustraciones, lista de, 5.7.2 índice,
Cláusula 3, 5.7, 5.7.3, el contenido de información del
anexo B, Cláusula 4

información para el uso de la documentación, 4,4 información

para el uso del software, componentes iniciales 4.6, 3.2 el
modo de instrucción, 2.6, 3.1, 4.7 instrucciones, 4,7

introducción, la cláusula 3, 3,2

salto, 3.1, 5.8

teclado, 5.6 palabra clave,

el Anexo B

etiqueta, paquete, 4,3

legibilidad, 5,3
niveles de subdivisión, 3.1 enlace,
3.1, 5.8
Lista de ilustraciones, la cláusula 3, literales 5.7.2,
5.6

Copyright © 2001 IEEE. Todos los derechos reservados. 17

IEEE
Std 1063-2001 SOFTWARE Norma IEEE para

METRO

modo, el uso, 2,15, Cláusula 4

norte

navegación, Cláusula 3, 4.6, 5.8 nota,

2,7, 5,1, 5,4
avisos, derechos de autor y marca registrada, 4,3

formato en línea, la cláusula 5

entorno operativo, 4,3 organización.
Ver estructura.

PAG

etiqueta del envase, 4.3

página 3.1
número de página, 5,8
prefacio, Cláusula 3 de
impresión, 5,2
la resolución del problema, 4,9 procedimiento,
2.8, Cláusula 3, 3.1, 4.7 propósito, 1,2

rojo, 5,3
modo, 2.9, 3.1, Cláusula 4, 4.1, 4.8, 4.9, la cláusula 5, 5.8 fuentes de información
relacionados, Cláusula 3, 4,11 restricciones, 4.3 referencia

alcance, 1.1
pantalla, 3.1

Capacidad de búsqueda, la cláusula 3, 5.7.4 tamaño de la

documentación, comandos de software cláusula 5, la

cláusula 3, 3.1, documentación de usuario del software

4.8, 2.11 paso, 2,12

pasos, de instrucción, 4.7, 5.4, 5.5 pasos,

numeradas, 5.5 estructura, estilo Cláusula 3,
2,13

subdivisión, niveles de, 3,1

18 Copyright © 2001 IEEE. Todos los derechos reservados.

 IEEE
DOCUMENTACIÓN DEL USUARIO Std 1063-2001

pestaña, 5,8 mesa. Ver ilustración.

tabla de contenido, la cláusula 3, 3.2, 5.7.1 sastrería, 1,4 orientado a la

tarea. Ver el modo de instrucción. soporte técnico, 5.2 terminología, 5,1
teoría de las operaciones. Ver concepto de operaciones. título, 5.7.1,
5.7.2, 5.8 página de título, la cláusula 3, 4,3 título, ilustración, 5,9
tema, 3.1, 3.2 notificación marca registrada, 4,3 tutorial, 2,14, 4,7

actualizaciones, 4.2

modo de uso, 2,15, Cláusula 4 uso de la

norma, la Cláusula 1 de usuario, 2,16

elemento de la interfaz de usuario, 5.6

variables, 5.6

advertencia, 2.17, 3.2, 3.3, 4.3, 4.7, 5.1, 5.4, entorno de trabajo Anexo
B, los usuarios, la cláusula 5, 5,6

Copyright © 2001 IEEE. Todos los derechos reservados. 19