Por favor, clique aqui para ajudar David McMurrey pagar a conta de hospedagem do site:
Doe qualquer quantia pequena que você puder!
A escrita técnica online continuará sendo gratuita.
Titulando Frases
Títulos de documentos mais longos, como techdocs formais, guias do usuário e white papers, às vezes são muito breves. Por exemplo, se o título de um techdoc fosse "Relatório sobre a Poluição por Plástico," o documento poderia ter mais de 300 páginas. Se fosse "Avaliação de Métodos de Reciclagem de Plástico," o documento poderia ser mais manejável.
Claro, você não quer que um documento tenha o título do que John Milton, o poeta inglês, criou em 1641: Da Reforma da Disciplina da Igreja na Inglaterra: E as Causas que até agora a têm impedido. Dois Livros, Escritos para um Amigo.
Apenas pense em todas as coisas que você poderia dizer sobre cada um desses tópicos! Importante também é o fato de que os leitores não vão saber apenas por esses títulos o que você realmente vai abordar.
Elementos da formulação de títulos
Ao elaborar um título para o seu documento, considere indicar esses elementos, mas sem criar um título que seja um parágrafo longo:
- Tópico: O tema do seu documento pode ser semelhante àqueles exemplos acima. Mas não pare por aí—você ainda tem mais trabalho a fazer.
- Escopo: O escopo refere-se a quão amplo ou quão restrito será seu foco no tópico. Escopo e visão geral nem sempre são fáceis de distinguir. O elemento visão geral indica uma revisão geral de algum aspecto do tema.
- Visão geral: Como o termo é usado aqui, uma visão geral refere-se a uma listagem dos principais subtópicos a serem abordados. É verdade, é contraditório em relação à forma como o termo é usado para definir escopo. Não se preocupe—isto não é ciência. Um bom exemplo desse uso do termo é este: Ebola: Transmissão, Sintomas, Tratamento. As três palavras finais são a itemização.
Observe que o processo de criar um título específico e focado é semelhante ao processo de narrowando um tópico, coberto em outro lugar.
Exemplos de formulação de títulos
Considere este título: Nanotecnologia: Visão Geral das Aplicações Médicas. O tópico gigante nanotecnologia é de fato afirmado, mas note que é limitado a aplicações médicas e um elemento de escopo é aplicado—visão geral.
Observe o uso do dois-pontos no exemplo anterior. Ele permite que você reduza o número de palavras. Outra possibilidade é Aplicações Médicas da Nanotecnologia: Visão Geral.
Formulação do título do problema
Um problema comum com documentos técnicos envolve títulos excessivamente gerais e vagos, por exemplo:
Relatório sobre Nanotecnologia
Relatório sobre o Ebola
Relatório sobre Smartphones
Relatório sobre Energia Solar
Relatório sobre Grafeno
Design e Formato da Página de Título
O capítulo sobre design de techdoc apresenta uma ideia bastante espartana da página de título, mostrada aqui à esquerda. No entanto, muitos techdocs têm lindas imagens incluídas na página de título, como mostrado à direita:
 |
 |
Agradeceria suas opiniões, reações e críticas em relação a este capítulo: sua resposta—David McMurrey.
