Design de página significa coisas diferentes para pessoas diferentes, mas aqui significará o uso de tipografia e formatação, como você vê em documentos profissionalmente projetados.
nosso foco aqui é a documentação técnica, o que implica em um design modesto e funcional.
Para ainda mais detalhes do que você vê aqui, consulte esses dois recursos padrão da indústria:
- Publicações Técnicas da Sun. Leia-me primeiro! Qualquer edição recente. Prentice Hall.
- Microsoft Corporation. Manual de Estilo da Microsoft para Publicações Técnicas. Qualquer edição recente. Microsoft Press.
Cabeçalhos e Rodapés
As pessoas costumam confundir cabeçalhos com títulos. Os títulos, abordados em títulos são essas frases que ocorrem dentro da área do corpo de um documento. Os cabeçalhos são aquelas frases e possivelmente números de página que ocorrem dentro da área do cabeçalho de um documento. Os rodapés são aquelas frases e possivelmente números de páginas que ocorrem dentro da área do rodapé de um documento. Um erro comum, e grande, é colocar o título de um documento na área do cabeçalho, o que faz com que ele apareça no topo de todas as páginas subsequentes.
Dê uma olhada em um diagrama de uma página de documento típica:
Um design comum de página é colocar o título do documento e o número da página na área do rodapé. Em um formato alternado, a página esquerda pode exibir o número da página e o título do documento, nessa ordem; a página direita pode exibir o título do documento e o número da página, nessa ordem.
Títulos
A seguir, apresentamos algumas das diretrizes padrão sobre cabeçalhos. Para uma discussão mais detalhada, consulte o capítulo sobre títulos no livro didático online.
- Faça uso liberal de subtítulos, talvez um subtítulo a cada dois ou três parágrafos. Claro que os subtítulos podem ser exagerados: muitos subtítulos com apenas uma ou duas frases por subtítulo não funcionam.
- Designe os títulos de modo que indiquem claramente seu nível. Use tamanho da fonte, estilo da fonte, cor, negrito, itálico e alinhamento de maneira que o nível do título seja óbvio. ("Níveis" de títulos são como níveis em um esboço: o primeiro nível corresponderia aos números romanos; o segundo nível, às letras maiúsculas; e assim por diante.)
- Faça os títulos descritivos das seções que introduzem. Títulos como "Contexto Técnico" não dizem nada a ninguém.
- Fazer cabeçalhos paralelo na formulação. O paralelismo envia aos leitores pistas importantes sobre se a seção é semelhante em natureza às anteriores.
- Evite "títulos isolados" — é o mesmo conceito de ter um "A" sem um "B" ou um "1" sem um "2" em esboços.
- Evite "títulos empilhados" — que são dois ou mais títulos consecutivos sem texto interveniente.
- Evite se referir a cabeçalhos com pronomes no texto que segue os cabeçalhos. Se você tiver um cabeçalho como "Configurando o Software", não o siga com uma frase como "Esta próxima fase..."
- Considere usar o formato "cabeçalho suspenso" para fazer os títulos se destacarem mais e reduzir o comprimento das linhas do texto regular. No design de cabeçalho suspenso, alguns ou todos os títulos estão na margem esquerda, enquanto todo o texto é recuado de uma a duas polegadas.
- Considere usar títulos "run-in" para seu título de nível mais baixo. Pode ser difícil confiar apenas no estilo e no tamanho da fonte para indicar os níveis dos títulos. Um título run-in "se mistura" ao início de um parágrafo e termina com um ponto. Você pode usar uma combinação de negrito, itálico ou cor para esses títulos.
Listas
Listas são ferramentas úteis para enfatizar pontos importantes, permitindo uma leitura rápida do texto e proporcionando mais espaço em branco. A seguir, são apresentadas algumas das diretrizes padrão sobre listas. Para uma discussão mais detalhada, veja o capítulo sobre listas.
- Use listas numeradas para itens que estão em uma ordem requerida ou que devem ser referidos por número. Use listas com marcadores para itens em nenhuma ordem requerida.
- Use o formato de listas numeradas e com marcadores padrão disponíveis nos estilos de parágrafo de softwares de processamento de texto, tags HTML e outros.
- Faça a formatação dos itens da lista. paralelo.
- Introduza todas as listas com uma introdução; não use títulos como introduções para listas.
- A menos que o estilo da sua organização sobreponha, pontue os itens da lista com um ponto apenas se forem frases completas ou tiverem orações dependentes embutidas.
- Use inicial maiúscula ou minúscula na primeira palavra dos itens da lista, mas faça isso de forma consistente.
- Para listas aninhadas, use um travessão em negrito como símbolo de marcador nos itens da segunda camada; use letras minúsculas para os itens numerados da segunda camada. Certifique-se de que os itens aninhados estejam alinhados com o texto ou o nível anterior.
- Evite o uso excessivo de listas ou listas com muitos itens. De sete a dez itens é geralmente considerado o máximo para listas.
Avisos
Os avisos são aqueles trechos de texto especialmente formatados que alertam os leitores sobre pontos especiais, exceções, problemas potenciais ou perigos. A seguir, apresentam-se algumas das diretrizes padrão para avisos. Para uma discussão mais detalhada, consulte o capítulo sobre avisos.
- Use uma hierarquia padrão de avisos em que os avisos se tornem mais proeminentes e notáveis à medida que se tornam mais graves.
- Considere usar esta hierarquia:
- avisos de perigo para situações envolvendo ferimentos graves ou fatalidades potenciais
- avisos para situações envolvendo lesões leves
- cautelas para situações envolvendo danos a equipamentos ou dados ou ameaça ao sucesso do procedimento
- notas para pontos de exceção ou ênfase que não envolvam as situações anteriores.
- Qualquer design de aviso que você usar, evite texto extenso em negrito, itálico, letras maiúsculas ou combinações desses estilos.
- Além de dizer aos leitores para fazer ou não fazer algo, explique o que acontecerá se eles ignorarem o aviso, sob quais condições utilizar a afirmação, como se recuperar se a afirmação for ignorada.
- Faça o texto dos avisos sucinto, mas sem sacrificar a clareza da escrita. Evite um estilo telegráfico de escrita (omissão de artigos como). a, um, o) em avisos.
- Em listas numeradas, alinhe os avisos para o texto do item da lista ao qual se aplicam.
- A sabedoria padrão de colocar avisos antes o passo em que o problema potencial existe pode causar problemas na formatação. Se possível, declare avisos, precauções ou perigos no início de todo o procedimento.
Figuras
Figuras são todo tipo de ilustrações, desenhos, esquemas, fotos e assim por diante. Veja gráficos para uma discussão detalhada. Enquanto isso, aqui estão alguns pontos importantes:
- No texto antes da figura, forneça uma referência cruzada para a figura.
- Embora não seja absolutamente necessário incluir uma legenda (título) para cada figura, quando você o fizer, coloque-o abaixo a figura.
- Por exemplo, nas instruções, quando as figuras estão intimamente relacionadas aos passos individuais, os títulos das figuras não têm uma função vital e não são necessários.
Mesas
As tabelas são como listas verticais, discutidas anteriormente, mas mais estruturadas e formais. Em seu texto, procure por pares, trios ou quartetos de itens que podem ser formatados como tabelas. Por exemplo, uma série de termos e definições é um uso clássico para tabelas. A seguir, apresentamos algumas das diretrizes padrão para tabelas. Para uma discussão mais detalhada, consulte o capítulo sobre mesas.
- Procure grupos repetidos de itens em seu texto que você pode formatar como tabelas.
- No texto antes da tabela, forneça uma referência cruzada para a tabela.
- Use um título de tabela, a menos que o conteúdo da tabela seja totalmente óbvio e a tabela contenha poucos itens. Coloque o título da tabela acima a tabela, ou torná-la a primeira linha da tabela.
- Use cabeçalhos de coluna e linha (ou ambos) para definir o conteúdo das colunas e linhas. Considere usar algum tipo de destaque para esses cabeçalhos de coluna e linha.
- Alinhe à esquerda as colunas de texto (exceto se forem itens simples de caracteres alfabéticos). Alinhe à esquerda as colunas de texto com seus cabeçalhos.
- Alinhe à direita ou alinhe decimal os dados numéricos, e centralize-os sob seu cabeçalho.
- Coloque unidades de medida padrão (ft, mm, gal.) no cabeçalho da coluna ou da linha, em vez de com cada item na coluna ou linha.
- Forneça uma breve discussão sobre a principal tendência na tabela—o que você quer que os leitores notem.
Destacando
A documentação de software geralmente utiliza muito destaque. Destaque aqui refere-se a negrito, itálico, fontes alternadas, letras maiúsculas, aspas e outras artimanhas tipográficas usadas para chamar a atenção para o texto. O seguinte apresenta algumas diretrizes padrão para destaque. Para uma discussão mais detalhada, consulte o capítulo sobre realçando.
- Estabeleça um plano para o uso de destaques e aplique-o de forma consistente. Utilize o destaque por razões específicas e funcionais. Evite excesso de destaque; evite esquemas de destaque complicados.
- Considere usar este esquema de destaque bastante padrão:
- Para ênfase simples, use itálico.
- Use **negrito** para **comandos**, **botões na tela** e **opções de menu**.
- Use itálico para variáveis para as quais os usuários devem fornecer suas próprias palavras.
- Use uma fonte alternativa para o texto exibido na tela ou para o texto que os usuários devem digitar.
- Para nomes de tela e campo, use o estilo de capitalização mostrado na tela, mas sem nenhum outro destaque.
- Use uma letra maiúscula para os nomes das chaves, mas sem nenhuma outra ênfase.
- Para ênfase estendida, use o formato de aviso.
Margens, Indentação e Alinhamento
Como mencionado na seção sobre títulos, um toque interessante é indentar o texto de uma a duas polegadas, enquanto deixa os títulos nas margens à esquerda. Este estilo faz duas coisas: destaca os títulos e encurta o comprimento das linhas do texto regular.
Fontes & Cor
Aqui estão algumas sugestões sobre fontes e cores:
- Use apenas uma fonte alternativa, no máximo duas. Por exemplo, você pode usar Arial para cabeçalhos, Times New Roman para o texto do corpo e Courier New para texto que é exibido na tela ou que os usuários devem digitar.
- Se você usar cor, use-a minimamente. Por exemplo, se você tiver texto preto em um fundo branco, pode escolher outra cor para os títulos. Você pode usar essa mesma cor para títulos de figuras e tabelas, bem como para as etiquetas de avisos (os rótulos "Nota", "Aviso", "Cuidado" e "Perigo" nos avisos).
- Evite combinações incomuns de cores de fundo e texto. Por exemplo, texto roxo ou vermelho em um fundo preto é horrível de ler. Fique com texto preto em um fundo branco ou cinza, a menos que haja uma forte razão funcional para alguma outra combinação de cores.
Eu apreciaria seus pensamentos, reações e críticas em relação a este capítulo: sua resposta.
