5.

6 Formatos de representacin de elementos de la interfaz de usuario

Interfaz grfica 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 documentacin por formatos grficos o tipogrficos coherentes, de modo que los diversos
elementos son distinguidos a partir del texto. La documentacin debe incluir una representacin del elemento,
su propsito, y una explicacin de su accin (consecuencia funcional), con ejemplos de casos reales de
funcionamiento. La documentacin en linea puede incluir etiquetas emergentes de texto para elementos de la
GUI.
Formatos de documentacin de los comandos introducidos por el usuario o cdigos debern 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 documentacin 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 documentacin para acceder a la informacin
La documentacin debe contener caractersticas para facilitar el acceso a la informacin, incluyendo una tabla de
contenidos; una lista de figuras, tablas o ilustraciones; un ndice; y capacidades de bsqueda electrnica.
5.7.1 Tabla de contenidos

Una tabla de contenidos seguir inmediatamente a los datos de identificacin (ver 4.3). La tabla de contenido
enumerar los ttulos de los captulos o temas de un documento con un punto de acceso para cada uno (su
nmero de pgina inicial o un enlace electrnico). Documentos con menos de ocho pginas despus de los datos
de identificacin pueden omitir la tabla de contenidos.
La tabla de contenido puede estar integral o simple. Un ndice exhaustivo de lista todos captulo o ttulos de los
temas (rbricas) hacia abajo hasta el tercer nivel. Una sencilla tabla de contenidos incluye slo el primer nivel
rbricas. Los documentos con una simple tabla de contenido puede incluir tablas completas secundarias de
contenidos que aparecen al principio de cada captulo o tema, o accesibles a travs de pop-ups, listas
ampliables, o ventanas secundarias. La documentacin electrnica 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 volmenes en el conjunto.
La tabla de contenido deber incluir todas las partes de la documentacin, incluidos los preliminares que sigue
la de tabla de contenidos y el anexo (por ejemplo, apndices, glosario e ndice). Los ttulos de la tabla
de contenidos debern ser idnticos en trminos a los del documento, incluyendo nmeros de captulo o tema.
Los formato de la tabla de contenido deber distinguir la jerarqua de las partidas por la tipografa consistente o
sangra. En la documentacin impresa, la tabla de contenido deber enumerar los ttulos en el mismo orden que
en el texto. Para obtener la documentacin electrnica, la tabla de contenido debe ordenar los encabezados de
acuerdo para buscar la secuencia, tarea, el tipo de tema, u otros criterios lgicos.
5.7.2 Lista de ilustraciones
La documentacin debe contener una lista de tablas, una lista de figuras, o una lista de ilustraciones (incluyendo ambas
tablas y figuras) si el documento contiene ms 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 nmeros de
ilustracin y ttulos con un punto de acceso para cada uno (como su nmero de pgina inicial o un enlace electrnico).
Los ttulos de la lista de tablas, figuras o ilustraciones debern ser idnticas en redaccin a los del documento, que
incluye una mesa, figura o nmeros de ilustracin.

5.7.3 ndice
Un ndice es una lista alfabtica de palabras clave, grficos o conceptos con un punto de acceso para cada uno.
A documentos impresos de ms de 40 pginas se incluye un ndice, cuyo puntos de acceso pueden ser nmeros
de pgina, tema nmeros, nmeros de ilustracin, o referencias a otra entrada del ndice. Los documentos
electrnicos ms de 40 temas incluir ya sea una herramienta de bsqueda (ver 5.7.4) o un ndice cuyos puntos
de acceso son enlaces electrnicos. Anexo B proporciona orientacin para la documentacin de usuario de
indexacin. 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 documentacin y no apuntar a una entrada del tercer ndice.
Capacidad 5.7.4 Buscar
La documentacin electrnica facilitar un mtodo de localizacin de palabras en el texto. Capacidad de
bsqueda electrnica puede incluir la bsqueda de texto completo del documento o conjunto de documentos;
buscar palabras en las ilustraciones; palabra claves a buscar; la bsqueda de una cadena de texto en el tema
actual; una bsqueda booleana; y la restriccin de una bsqueda especfica para captulos, temas o pginas.

5.8 Formatos de caractersticas para la navegacin

Caractersticas para la navegacin incluyen captulos y temas aparte; pgina o pantalla ttulos; captulo, ttulo,
pgina, y nmeros de pantalla; las pestaas; encabezados y pies de pgina; marcadores; saltos (links);
referencias cruzadas; navegacin de iconos; y botones. Las caractersticas para la navegacin se proporcionarn
de manera que los usuarios pueden determinar su ubicacin en el documento impreso o electrnico y todos los
lugares a los que pueden pasar de su actual ubicacin. La documentacin debe incluir explicaciones de las
funciones de navegacin del sistema y especficas del documento. En la documentacin impresa, cada pgina
tendr un nmero de pgina nica. En la documentacin electrnica, cada pgina o pantalla tendr un
identificador nico (alfanumrica y / o leyenda) accesible para el usuario. Navegacin de caractersticas
permitirn a los usuarios del documento ir a los siguientes lugares:
-De Vuelta, Para volver a la seccin / pgina ms recientemente salt de (vinculado)
-A continuacin, el tema siguiente lgica / pgina en la secuencia de temas (si los hay)
- Anterior, lgico tema / pgina anterior a la que se est viendo (si los hay)
- Tabla de contenido (si tiene)
- Indice (si los hay)
Las funciones de navegacin utilizarn formatos consistentes para la tipografa como enlaces subrayados, color,
o grficos para distinguirlos de texto sin formato. Las funciones de navegacin deben permanecer accesibles en
una ubicacin esttica si es electrnico documentacin permite desplazarse por el texto. Jumps (enlaces)
debern presentar una clara indicacin del destino del enlace. Por ejemplo, utilice "Mas consejos a la solucin
de problemas "en lugar de" Haga clic aqu ". Los enlaces deben proporcionar la informacin que el usuario
espera de un salto, en lugar de exigir un enlace a otro vnculo que tiene la informacin buscada. Si el destino es
fuera de la documentacin, la documentacin debe proporcionar a los usuarios una forma alternativa de la
localizacin de la informacin, en caso de que el vnculo se ha roto o el destino eliminado. Los vnculos 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 informacin relacionada en el otro tema. La documentacin en modo de
referencia electrnica ser accesible desde el software documenta, y proporcionar

un medio claro de salir de la documentacin y de regresar al software. El software puede estar vinculado a
ayuda en lnea, tutoriales o documentacin a modo de referencia en varias maneras, tales como las siguientes:
- A travs de un men de ayuda vinculada a una lista de temas o de un punto de entrada al sistema de ayuda
- A travs de los botones de ayuda en las pantallas de software que proporcionan informacin sobre un tema en
particular (cuadro de dilogo y sobre el terreno ayuda)
- A travs de ayuda sensible al contexto y el pop-up de texto (informacin sobre herramientas)

5.9 Formatos de las ilustraciones

Las ilustraciones que acompaan al texto deben aparecer junto a su primera referencia en el texto, por lo que el
texto asociado y la ilustracin se pueda n ver simultneamente. En la documentacin con ms de cinco
ilustraciones, cada uno ilustracin debe tener un nico nmero y ttulo (ver 5.7.2). Ilustraciones informales, que
se refiere slo una vez en el texto o tener ningn texto, pueden ser sin ttulo y sin numerar.
El formato de ilustraciones de contenido similar ser coherente para la escala, tamao de pantalla, tipos de letra,
grosor de lnea, y el uso del color. En la documentacin electrnica, ilustraciones deben ser de un tamao que
sean legibles y visibles en su totalidad, sin necesidad de desplazarse, en el dispositivo de visualizacin
esperado. Considere la posibilidad de simplificar o mostrando slo caractersticas sobresalientes de un grfico
grande por lo que es visible a la vez sin tener que desplazarse. Mesas largas que no caben en una sola pgina
deber repetir el ttulo de la tabla y de columna o fila encabezados en cada pgina o dos pginas. Largo
tablas que abarcan varias pginas, se deben identificar con un nmero de la hoja, por ejemplo, "Tabla 15.
Mtricas unidades (hoja 2 de 4) ".
Documentacin que se destina para la impresin y distribucin electrnica debe ser lgicamente completa,
incluyendo ilustraciones y referencias a las ilustraciones, en ambos medios. Pueden ser necesarios menos
ilustraciones en documentacin electrnica que permite enlaces a las pantallas del software reales. Las
representaciones de elementos de la GUI en la documentacin debe ser coherente con la versin del software
que se est documentada.