Como escrever documentação do usuário para um guia de estilos da Web

Guias de estilo estabelecem as regras de uso para os elementos visuais de uma marca; eles são comumente usados ​​por organizações que desejam manter uma imagem consistente em todo o conteúdo criado por muitas pessoas. Um guia de estilo da Web é particularmente importante se o conteúdo on-line for criado e editado por usuários com diferentes níveis de habilidade. Ao definir regras específicas para páginas da Web associadas à sua organização, você pode ajudar a garantir que todas as páginas promovam uma identidade profissional e consistente. À medida que você escreve a documentação do usuário para um guia de estilo, use uma linguagem clara e concisa e grave para os usuários com os níveis mais baixos de habilidades de design da Web.

1

Abra a documentação com uma explicação geral dos layouts da Web e estilo para cada tipo de página. Embora as categorias de página específicas variem por organização, considere páginas de destino, páginas de título, páginas iniciais, páginas de subcategorias, páginas somente de imagem e páginas somente de texto. Use um diagrama estrutural para explicar hierarquias complexas de informações e inclua gráficos que mostrem exemplos de cada layout.

2

Explique como os logotipos podem ser usados ​​em diferentes tipos de páginas da Web. Deixe os usuários saberem onde devem colocar o logotipo e listar os limites superior e inferior para o tamanho. Se você tiver vários layouts de logotipo e variações de cores, liste os locais em que eles podem ser usados; usar a marca do logotipo sozinha pode ser permitido em uma página que usa o título completo da organização no título, por exemplo. Inclua os arquivos de logotipo em sua documentação com as dimensões para facilitar a gravação da versão correta pelos usuários. Feche o texto com uma frase que avisa os usuários para não alterarem as cores, a forma, o tamanho ou o layout do logotipo para evitar edições não autorizadas.

3

Liste as fontes específicas que devem ser usadas em todas as páginas da Web da sua organização. Inclua as fontes para títulos, subtítulos, títulos, texto do corpo, legendas e citações. Para cada categoria, defina o nome da fonte, tamanho e se é negrito, itálico, sublinhado ou em maiúsculas.

4

Escreva sobre as exceções da Web para o guia de estilo offline da organização. Inclua elementos que não sejam um problema com os materiais impressos, por exemplo, como apresentar links no texto ou incluir ou não fontes externas no final de uma página. Se o seu grupo tiver um estilo on-line mais informal, explique aos usuários como obter o tom ao escrever uma cópia da Web.

5

Diga aos usuários que cores eles podem usar ao projetar páginas. Liste as cores para cada tipo de texto, contorno de foto, cabeçalho, barra de navegação e separador de página. Forneça os códigos de cores RGB específicos para garantir a consistência. Explique aos usuários que a cor é uma maneira poderosa de expressar sua imagem de marca e alertá-los para usar apenas as cores indicadas para preservar a experiência geral do usuário.

6

Exponha as regras para o uso de fotos nas páginas da Web da organização. Se todas as suas páginas tiverem um design específico, explique onde os usuários podem colocar fotos. Liste as dimensões em pixels necessárias para diferentes usos: fotos em texto, fotos de cabeçalho ou fotos da barra lateral, por exemplo. Para tornar o site mais fácil de carregar, dê resoluções de imagem específicas - para a Web, 72 dpi é o padrão. Diga aos usuários para cortar, redimensionar e editar as imagens antes de colocá-las no site para otimizar a velocidade.

7

Feche a documentação explicando a declaração exigida ou os elementos de design que devem estar em cada tipo de página. Inclua itens como declarações de emprego com igualdade de oportunidades e avisos de direitos autorais e informe aos usuários o posicionamento exato na página. Se você tiver um gráfico ou imagem que deve aparecer na página, liste os requisitos de veiculação e forneça o arquivo para download imediato.

Publicações Populares