Design da página significa coisas diferentes para pessoas diferentes, mas aqui significará o uso de tipografia e formatação, como você vê em documentos projetados profissionalmente.
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 estes dois recursos padrões da indústria:
- Publicações Técnicas da Sun. Leia-me Primeiro! Qualquer edição recente. Prentice Hall.
- Microsoft Corporation. Manual da Microsoft de Estilo 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. Títulos, abordados em títulos são essas frases que ocorrem dentro da área do corpo de um documento. 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ágina que ocorrem dentro da área de rodapé de um documento. Um erro comum, e um grande erro, é colocar o título de um documento na área do cabeçalho, o que faz com que ele apareça no topo de cada página subsequente.
Dê uma olhada em um diagrama de uma página de documento típica:
Um design de página comum é colocar o título do documento e o número da página na área do rodapé. Em um formato alternado, a página da esquerda pode exibir o número da página e o título do documento, nessa ordem; a página da direita pode exibir o título do documento e o número da página, nessa ordem.
Títulos
O seguinte apresenta 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.
- Use bastante cabeçalhos, talvez um cabeçalho para cada dois ou três parágrafos. Claro, os cabeçalhos podem ser excessivos: muitos cabeçalhos com apenas uma ou duas frases por cabeçalho não funcionam.
- Projete os títulos de forma que indiquem claramente seu nível. Use tamanho de fonte, estilo de fonte, cor, negrito, itálico, e alinhamento de forma 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 "Fundo Técnico" não informam ninguém sobre nada.
- Faça títulos paralelo na formulação. O paralelismo envia aos leitores pistas importantes sobre se a seção é semelhante às anteriores.
- Evite "cabeçalhos isolados"—é o mesmo conceito de ter um "A" sem um "B" ou um "1" sem um "2" em esquemas.
- Evite "títulos empilhados"—que são dois ou mais títulos consecutivos sem texto intermediário.
- Evite se referir a títulos com pronomes no texto que segue os cabeçalhos. Se você tiver um título como "Configurando o Software", não o siga com uma frase como "Esta próxima fasehttps://mcmassociates.io.".
- Considere usar o formato "cabeça suspensa" para fazer os títulos se destacarem mais e reduzir o comprimento das linhas de texto regular. No design de cabeça suspensa, alguns ou todos os títulos ficam na margem esquerda, enquanto todo o texto é recuado de uma a duas polegadas.
- Considere usar "títulos corridos" para seu título de nível mais baixo. Pode ser difícil confiar apenas no estilo e tamanho da fonte para indicar os níveis dos títulos. Um título corrido "se integra" 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 rápida leitura do texto e proporcionando mais espaço em branco. O seguinte apresenta 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 necessária ou que devem ser referidos por número. Use listas com marcadores para itens em nenhuma ordem necessária.
- Use o formato padrão de listas numeradas e com marcadores disponíveis nos estilos de parágrafo de softwares de processamento de texto, tags HTML e outros.
- Faça a redação dos itens da lista. paralelo.
- Introduza todas as listas com uma introdução; não use cabeçalhos como introduções para listas.
- A menos que o estilo da sua organização anule, pontue os itens da lista com um ponto apenas se forem frases completas ou tiverem orações dependentes embutidas.
- Use letra maiúscula ou minúscula na primeira palavra dos itens da lista, mas faça isso de maneira consistente.
- Para listas aninhadas, use um travessão em negrito como símbolo de marcador nos itens da lista de segundo nível; use letras minúsculas para os itens da lista numerada de segundo nível. Certifique-se de que os itens aninhados estejam alinhados ao 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 blocos de texto especialmente formatados que alertam os leitores sobre pontos especiais, exceções, problemas potenciais ou perigo. A seguir, apresentamos algumas das diretrizes padrão para avisos. Para uma discussão mais detalhada, consulte o capítulo sobre avisos.
- Utilize uma hierarquia padrão de avisos na qual os avisos se tornam mais proeminentes e notáveis à medida que se tornam mais severos.
- Considere usar esta hierarquia:
- avisos de perigo para situações que envolvem risco de ferimentos graves ou fatalidade
- avisos para situações envolvendo lesões leves
- precauções para situações que envolvem danos a equipamentos ou dados ou ameaça ao sucesso do procedimento
- notas para pontos de exceção ou ênfase que não envolvem as situações anteriores.
- Qualquer design de aviso que você use, evite texto extenso em negrito, itálico, tudo em maiúsculas ou combinações disso.
- Além de informar os leitores para fazer ou não fazer algo, explique o que acontecerá se ignorarem o aviso, sob quais condições utilizar a declaração e como se recuperar caso a declaração seja ignorada.
- Torne o texto dos avisos sucinto, mas sem sacrificar a clareza da escrita. Evite o estilo de escrita telegráfica (omissão de artigos como). a, um, o) em avisos.
- Em listas numeradas, alinhe os avisos ao 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 todos os tipos de ilustrações, desenhos, esquemas, fotos e assim por diante. Veja gráficos para discussão detalhada. Enquanto isso, aqui estão alguns pontos importantes:
- No texto antes da figura, forneça uma referência cruzada à figura.
- Embora não seja absolutamente necessário incluir uma legenda (título) para cada figura, quando você o fizer, coloque-a abaixo a figura.
- Por exemplo, em 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 possam ser formatados como tabelas. Por exemplo, uma série de termos e definições é um uso clássico para tabelas. A seguir, apresentam-se 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 à tabela.
- Use um título de tabela, a menos que o conteúdo da tabela seja completamente ó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 colunas e cabeçalhos de linhas (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 as colunas de texto à esquerda (a menos que sejam itens simples de caracteres alfabéticos). Alinhe as colunas de texto à esquerda 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 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ê deseja que os leitores notem.
Destacando
A documentação de software tipicamente utiliza muitos destaques. Neste contexto, destaque refere-se a negrito, itálico, fontes alternadas, letras maiúsculas, aspas e outros truques tipográficos usados para chamar a atenção para o texto. A seguir, são apresentadas algumas diretrizes padrão para destaque. Para uma discussão mais detalhada, consulte o capítulo sobre destacando.
- Estabeleça um plano para o uso de marcação e aplique-o de forma consistente. Use a marcação por razões específicas e funcionais. Evite excesso de marcação; evite esquemas de marcação 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 telas e campos, use o estilo de capitalização mostrado na tela, mas não use nenhuma outra forma de destaque.
- Use uma maiúscula inicial para os nomes de chave, mas sem nenhum outro destaque.
- Para ênfase estendida, utilize o formato de aviso.
Margens, Recuo & Alinhamento
Como mencionado na seção sobre títulos, um toque agradável é 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 e Cores
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 títulos, 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 cabeçalhos. Você pode usar essa mesma cor para títulos de figuras e tabelas, bem como para as etiquetas de avisos (os rótulos reais de "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.
