Por favor, clique aqui para ajudar David McMurrey pagar a conta de hospedagem do seu site:
Doe qualquer quantia pequena que você puder!
A escrita técnica online continuará gratuita.
Fraseado do Título
Títulos de documentos mais longos, como documentos técnicos formais, guias de usuário e white papers, às vezes são muito breves. Por exemplo, se o título de um documento técnico fosse "Relatório sobre a Poluição Plástica", 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 administrável.
Claro, você não quer que um documento tenha um título do qual John Milton, o poeta inglês, elaborou em 1641: Da Reforma da Disciplina da Igreja na Inglaterra: E as Causas que até agora a têm impedido. Dois Livros, Escritos a um Amigo.
Basta pensar em todas as coisas que você poderia dizer sobre cada um desses tópicos! Importante também é o fato de que os leitores simplesmente não vão saber, apenas com esses títulos, o que você realmente vai abordar.
Elementos da formulação de títulos
Ao criar um título para seu documento, considere indicar esses elementos, mas sem criar um título que seja um parágrafo longo:
- Tópico: O tópico do seu documento pode ser semelhante a esses exemplos acima. Mas não pare por aí—você ainda tem mais trabalho a fazer.
- Escopo: O escopo se refere a quão amplo ou quão restrito será o seu foco sobre o tema. 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 tópico.
- Visão geral: Como o termo é usado aqui, visão geral refere-se a uma lista dos principais subtópicos a serem cobertos. É verdade que é contraditório ao modo 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 discriminação.
Observe que o processo de criar um título específico e focado é similar ao processo de apurando 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 está restringido a aplicações médicas e um elemento de escopo é aplicado—visão geral.
Observe o uso dos dois pontos no exemplo anterior. Isso permite que você reduza o número de palavras. Outra possibilidade é Aplicações Médicas da Nanotecnologia: Visão Geral.
Redaçã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 Ébola
Relatório sobre Smartphones
Relatório sobre Energia Solar
Relatório sobre o 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.
