Por favor, clique aqui para ajudar David McMurrey pagar a conta de hospedagem do site:
Doe qualquer quantia pequena que puder!
A Escrita Técnica Online permanecerá gratuita.
Formulação de Títulos
Títulos de documentos mais longos, como documentos técnicos formais, manuais do usuário e artigos, às vezes são muito curtos. Por exemplo, se o título de um documento técnico fosse "Relatório sobre 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 gerenciável.
Claro, você não quer que um documento tenha um título semelhante ao 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 impediram. 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 pelos 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 tema 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 refere-se a quão amplo ou quão estreito será seu foco sobre o tópico. O escopo e a visão geral nem sempre são fáceis de distinguir. O elemento visão geral indica uma revisão geral de alguns aspectos do tópico.
- Visão geral: Como o termo é usado aqui, visão geral refere-se a uma relação dos principais subtópicos a serem abordados. É verdade que isso é contraditório em relação a 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 últimas palavras são a itemização.
Observe que o processo de criar um título específico e focado é semelhante ao processo de afunilando um tópico, abordado em outro lugar.
Exemplos de formulção de títulos
Considere este título: Nanotecnologia: Visão Geral das Aplicações Médicas. O tópico gigante nanotecnologia está de fato afirmado, mas note que é restrito 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 o Grafeno
Design e Formato da Página de Título
O capítulo sobre design de techdoc apresenta uma ideia bastante simples da página de título, mostrada aqui à esquerda. No entanto, muitos techdocs incluem lindas imagens na página de título, como mostrado à direita:
 |
 |
Eu apreciaria seus pensamentos, reações e críticas em relação a este capítulo: sua resposta—David McMurrey.
