Cómo escribir documentación de usuario para una guía de estilo web

Las guías de estilo establecen las reglas de uso para los elementos visuales de una marca; normalmente las utilizan las organizaciones que desean mantener una imagen coherente en todo el contenido creado por muchas personas. Una guía de estilo web es particularmente importante si su contenido en línea es creado y editado por usuarios con diferentes niveles de habilidad. Al establecer reglas específicas para las páginas web asociadas con su organización, puede ayudar a garantizar que cada página promueva una identidad profesional y coherente. A medida que escribe la documentación del usuario para una guía de estilo, use un lenguaje claro y conciso y escriba a los usuarios con los niveles más bajos de habilidad de diseño web.

1.

Abra la documentación con una explicación general de los diseños web y el estilo para cada tipo de página. Aunque las categorías de páginas específicas variarán según la organización, considere las páginas de destino, las páginas de título, las páginas de inicio, las páginas de subcategoría, las páginas de solo imagen y las páginas de solo texto. Use un diagrama estructural para explicar jerarquías complejas de información e incluya gráficos que muestren ejemplos de cada diseño.

2.

Explique cómo se pueden usar los logotipos en diferentes tipos de páginas web. Deje que los usuarios sepan dónde deben colocar el logotipo y enumerar los límites superior e inferior de tamaño. Si tiene múltiples diseños de logotipo y variaciones de color, haga una lista de los lugares en los que se pueden usar; el uso de la marca del logotipo solo podría estar permitido en una página que use el título completo de la organización en el título, por ejemplo. Incluya los archivos de logotipo en su documentación con las dimensiones para facilitar a los usuarios guardar la versión correcta. Cierre el texto con una oración que advierta a los usuarios que no cambien los colores, la forma, el tamaño o el diseño de su logotipo para evitar ediciones no autorizadas.

3.

Enumere las fuentes específicas que deben usarse en todas las páginas web de su organización. Incluya las fuentes para titulares, subtítulos, títulos, texto del cuerpo, subtítulos y citas. Para cada categoría, establezca el nombre de la fuente, el tamaño y si está en negrita, cursiva, subrayado o en mayúscula.

4.

Escriba acerca de las excepciones web a la guía de estilo sin conexión de la organización. Incluya elementos que no sean un problema con los materiales impresos, como la forma de presentar enlaces en el texto o si incluir o no fuentes externas al final de una página. Si su grupo tiene un estilo en línea más informal, explique a los usuarios cómo lograr el tono al escribir copias web.

5.

Indique a los usuarios qué colores pueden usar al diseñar páginas. Enumere los colores para cada tipo de texto, contorno de foto, encabezado, barra de navegación y separador de página. Dar los códigos de color RGB específicos para asegurar la consistencia. Explique a los usuarios que el color es una forma poderosa de expresar su imagen de marca y adviértales que usen solo los colores indicados para preservar la experiencia general del usuario.

6.

Establezca las reglas para el uso de fotos en las páginas web de la organización. Si todas sus páginas tienen un diseño específico, explique dónde pueden colocar las fotos los usuarios. Enumere las dimensiones en píxeles requeridas para diferentes usos: fotos en texto, fotos de encabezado o fotos de barra lateral, por ejemplo. Para hacer que el sitio web sea más fácil de cargar, proporcione resoluciones de imagen específicas: para la Web, 72 ppp es el estándar. Dígales a los usuarios que recorten, redimensionen y editen las imágenes antes de colocarlas en el sitio web para optimizar la velocidad.

7.

Cierre la documentación explicando la declaración requerida o los elementos de diseño que deben estar en cada tipo de página. Incluya elementos como declaraciones de empleo con igualdad de oportunidades y avisos de derechos de autor, y comunique a los usuarios la ubicación exacta en la página. Si tiene un gráfico o una imagen que debería aparecer en la página, haga una lista de los requisitos de ubicación y proporcione el archivo para su descarga inmediata.