Producto de trabajo: Guía de estilo de manuales
Este artefacto describe cómo deben desarrollarse los manuales de soporte del usuario final.
Objetivo

El objetivo de la Guía de estilo de manuales es describir los convenios estilísticos que se utilizarán para desarrollar los materiales de soporte para los usuarios. Una Guía de estilo de manuales da consejos, normas, ortografía general y términos específicos de dominio, estilo de frases y cuestiones de la escritura técnica.

Relaciones
RolesResponsable: Modificado por:
Entrada aObligatoria:
  • Ninguno
Opcional: Externa:
  • Ninguno
Salida de
Propiedades
Opcional
PlaneadoYes
Personalización
Opciones de representación

Es necesario contar con una guía de estilo de manuales si hay un volumen significativo de documentación de usuario, incluida la documentación impresa y en línea.

Utilice guías de estilo existentes, como por ejemplo [HAC97] y [MOS98], ya que hay pocos libros buenos disponibles sobre este tema.