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

Interfaz gráfica de usuario (GUI) elementos del software, como los botones, iconos, cursores variables y

punteros; usos especiales de las teclas del teclado o combinaciones de teclas; y las respuestas del sistema se

representan en documentación por formatos gráficos o tipográficos coherentes, de modo que los diversos

elementos son distinguidos a partir 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. La documentación en linea puede incluir etiquetas emergentes de texto para elementos de la

GUI.

Formatos de documentación de los comandos introducidos por el usuario o códigos deberán distinguir

claramente entre los literales (a ser de entrada exactamente como se muestra) y las variables (a ser seleccionado

por el usuario). Las comillas no se deben utilizar en representaciones de comando a menos que el usuario debe

introducir literalmente. La documentación debe abordar 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 facilitar el 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 contenidos seguirá inmediatamente a los datos de identificación (ver 4.3). La tabla de contenido

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 después de los datos

de identificación pueden omitir la tabla de contenidos.

La tabla de contenido puede estar integral o simple. Un índice exhaustivo de lista todos capítulo o títulos de los

temas (rúbricas) hacia abajo hasta el tercer nivel. Una sencilla tabla de contenidos incluye sólo el primer nivel

rúbricas. Los documentos con una simple tabla de contenido puede incluir tablas completas secundarias de

contenidos que aparecen al principio de cada capítulo o tema, o accesibles a través de pop-ups, listas

ampliables, o ventanas secundarias. La documentación electrónica puede mostrar tablas de contenido en

formatos extensibles y plegables para proveer de nivel superior y acceso detallado a las partidas sin

desplazamiento excesivo. Al menos un volumen de un conjunto de documentos deberá incluir una simple tabla

de contenidos para todos los volúmenes en el conjunto.

La tabla de contenido deberá incluir todas las partes de la documentación, incluidos los preliminares que sigue

la de tabla de contenidos y el anexo (por ejemplo, apéndices, glosario e índice). Los títulos de la tabla

de contenidos deberán ser idénticos en términos a los del documento, incluyendo números de capítulo o tema.

Los 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. Para obtener la documentación electrónica, la tabla de contenido debe ordenar los encabezados de

acuerdo para buscar la 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 las ilustraciones se debe 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.

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.

A documentos impresos de más de 40 páginas se incluye un índice, cuyo puntos de acceso pueden ser números

de página, tema números, números de ilustración, o referencias a otra entrada del índice. Los documentos

electrónicos más de 40 temas incluirá 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 orientación para la documentación de usuario de

indexación. Una entrada de índice puede ser referencia cruzada u otro índice entrada; Sin embargo, la entrada

de referencia dará un punto de acceso a la documentación y no apuntar a una entrada del tercer índice.

Capacidad 5.7.4 Buscar

La documentación electrónica facilitará un método de localización de palabras en el texto. Capacidad de

búsqueda electrónica puede incluir la búsqueda de texto completo del documento o conjunto de documentos;

buscar palabras en las ilustraciones; palabra claves a buscar; la búsqueda de una cadena de texto en el tema

actual; una búsqueda booleana; y la restricción de una búsqueda específica para capítulos, temas o páginas.

5.8 Formatos de características para la navegación

Características para la navegación incluyen capítulos y temas aparte; página o pantalla títulos; capítulo, título,

página, y números de pantalla; las pestañas; encabezados y pies de página; marcadores; saltos (links);

referencias cruzadas; navegación de iconos; y botones. Las características para la navegación se proporcionarán

de manera que los usuarios pueden determinar su ubicación en el documento impreso o electrónico y todos los

lugares a los que pueden pasar de su actual ubicación. La documentación debe incluir explicaciones de las

funciones de navegación del sistema y específicas del documento. En la documentación impresa, cada página

tendrá un número de página única. En la documentación electrónica, cada página o pantalla tendrá un

identificador único (alfanumérica y / o leyenda) accesible para el usuario. Navegación de características

permitirán a los usuarios del documento ir a los siguientes lugares:

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

-A continuación, el tema siguiente lógica / página en la secuencia de temas (si los hay)

- Anterior, lógico tema / página anterior a la que se está viendo (si los hay)

- Tabla de contenido (si tiene)

- Indice (si los hay)

Las funciones de navegación utilizarán formatos consistentes para la tipografía como enlaces subrayados, color,

o gráficos para distinguirlos de texto sin formato. Las funciones de navegación deben permanecer accesibles en

una ubicación estática si es electrónico documentación permite desplazarse por el texto. Jumps (enlaces)

deberán presentar una clara indicación del destino del enlace. Por ejemplo, utilice "Mas consejos a la solución

de problemas "en lugar de" Haga clic aquí ". Los enlaces deben proporcionar la información que el usuario

espera de un salto, en lugar de exigir un enlace a otro vínculo que tiene la información buscada. Si el destino es

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 vínculo se ha roto o el destino eliminado. Los vínculos entre

los temas relacionados deben ser bidireccional, por lo que cualquiera que sea el tema a los usuarios acceder en

primer lugar, que puede saltar a la información relacionada en el otro tema. La documentación en modo de

referencia electrónica será accesible desde el software documenta, y proporcionará

un medio claro de salir de la documentación y de regresar al software. El software puede estar vinculado a

ayuda en línea, tutoriales o documentación a modo de referencia en varias maneras, tales como las siguientes:

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

- A través de los botones de ayuda en las pantallas de software que proporcionan información sobre un tema en

particular (cuadro de diálogo y sobre el terreno ayuda)

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

5.9 Formatos de las ilustraciones

Las ilustraciones que acompañan al texto deben aparecer junto a su primera referencia en el texto, por lo que el

texto asociado y la ilustración se pueda n ver simultáneamente. En la documentación con más de cinco

ilustraciones, cada uno 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 para la escala, tamaño de pantalla, tipos de letra,

grosor de línea, y el uso del color. En la documentación electrónica, ilustraciones deben ser de un tamaño que

sean legibles y visibles en su totalidad, sin necesidad de desplazarse, en el dispositivo de visualización

esperado. Considere la posibilidad de simplificar o mostrando sólo características sobresalientes de un gráfico

grande por lo que es visible a la vez sin tener que desplazarse. Mesas largas que no caben en una sola página

deberá repetir el título de la tabla y de columna o fila encabezados en cada página o dos páginas. Largo

tablas que abarcan varias páginas, se deben identificar con un número de la hoja, por ejemplo, "Tabla 15.

Métricas unidades (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. Pueden ser necesarios menos

ilustraciones en documentación electrónica que permite enlaces a las pantallas del software reales. Las

representaciones de elementos de la GUI en la documentación debe ser coherente con la versión del software

que se está documentada.