Mejores prácticas para la documentación técnica - Planificación y estructuración de ayuda útil al usuario: Contenidos, Estructura, Navegación del usuario

Incluso la mejor información no tiene valor si los usuarios no pueden encontrarla. Proporcionar una estructura y navegación fáciles de usar es tan importante como proporcionar contenido bien redactado. Sin embargo, estructurar la asistencia al usuario no es tan simple y obvio como puede parecer. Si cree que la estructura de su documento debe seguir la estructura de los componentes y funciones de su producto: Está equivocado. Si cree que el tipo de documento que prefiere es el mismo tipo de documento que prefieren sus clientes: Está equivocado. Si cree que toda la información que tiene es importante: También está equivocado.

Este libro le enseña cómo estructurar, indexar y enlazar sus documentos para que los lectores realmente encuentren la información que necesitan.

Temas cubiertos:

• Principios generales de estructuración que todas las decisiones estructurales tienen en común.
• Elección de medios: ¿Debe proporcionar un manual de usuario impreso o imprimible (PDF), ayuda en línea, o ambos? ¿Qué información debe ir en el manual de usuario y qué información debe ir en la ayuda en línea? ¿Qué formato de ayuda debe usar? ¿Se pueden implementar llamadas de ayuda sensibles al contexto? ¿Debe proporcionar funciones interactivas?
• Planificación de documentos: ¿Debe poner toda la información en un solo documento, o debe proporcionar varios manuales de usuario para propósitos y grupos de usuarios específicos? ¿Cómo debe nombrar sus documentos?
• Planificación de secciones de documentos: ¿Cuáles son las secciones principales de las que deben constar sus documentos? ¿Hay alguna sección estándar que no deba olvidar?
• Planificación de temas: ¿Qué tipos de información necesitan sus clientes? ¿Cómo debe construir y nombrar los temas individuales dentro del documento?
• Planificación del orden de secciones y temas: ¿Cómo debe organizar las secciones y temas dentro de sus documentos? ¿Qué va primero? ¿Qué va después?
• Planificación de la navegación: ¿Qué dispositivos de navegación debe proporcionar en documentos impresos y en sistemas de ayuda en línea? ¿Dónde debe proporcionar enlaces o referencias cruzadas y dónde no?

Autor: Marc Achtelig
Editorial: Indoition Publishing E.K.
Publicado: 25/10/2020
Páginas: 174
Tipo de encuadernación: Tapa blanda
Peso: 0.53lbs
Tamaño: 9.02h x 5.98w x 0.37d
ISBN13: 9783943860122
ISBN10: 3943860124
Categorías BISAC:
- Computadoras | Documentación y Escritura Técnica
- Tecnología e Ingeniería | Escritura Técnica
- Computadoras | Programación | General

Este título no es retornable