Neste capítulo, design de livro significa o conteúdo, estilo, formato, design e sequência dos vários componentes típicos de um livro. "Componentes" aqui refere-se a seções ou páginas reais de um livro, como o aviso de edição, o prefácio, o índice ou a capa dianteira ou traseira. No capítulo de design de página, o termo elemento refere-se a coisas que podem ocorrer várias vezes praticamente em qualquer lugar de um livro, como cabeçalhos, rodapés, tabelas, ilustrações, listas, avisos, destaques, e assim por diante.
A seguir, é apresentado um resumo dos componentes típicos de um livro técnico impresso e do conteúdo, formato, estilo e sequência típicos desses componentes. Certamente, nenhum guia do usuário, manual de referência técnica, documento de referência rápida ou outro documento desse tipo terá todos esses componentes projetados e sequenciados da maneira precisa que você está prestes a ler. Em vez disso, esta revisão oferecerá uma visão geral das possibilidades—digamos que do leque de possibilidades.
Nota: Atualmente, temos apenas um exemplo manual do usuário desenvolvido no FrameMaker e, em seguida, exportado para PDF. Falta um glossário, mas todas as outras partes de um manual do usuário típico estão no lugar. (Não consigo descobrir aquele "d" em "Filepad"!) Esteja ciente de que não utiliza alguns dos requisitos de fonte e margem listados abaixo.
Antes de começar a ler o seguinte, pegue uma série de livros sobre hardware e software para que você possa comparar seu conteúdo, estilo, formato e sequenciamento com o que é discutido aqui.
Para ainda mais detalhes do que você vê aqui, consulte esses 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 de Estilo da Microsoft para Publicações Técnicas. Qualquer edição recente. Microsoft Press.
Você pode ver exemplos desses componentes do livro em Design de Techdoc.
Capa da frente e capa de trás
Os documentos do produto para clientes pagantes geralmente têm capas frontais bem projetadas, mesmo que, por dentro, o conteúdo seja de qualidade inferior. Na capa frontal, você verá tipicamente alguns ou todos os seguintes:
- Nome da empresa
- Nome do produto
- Plataforma de produto ou sistema operacional
- Números de versão e lançamento do produto
- Título do livro
- Logos de empresas ou produtos
- Símbolos de marca registrada
- Arte
- Número do pedido do livro
- Slogan da empresa ou produto
Pode ser desafiador encontrar um bom formato para o nome da empresa, nome do produto e título do livro. Às vezes, isso pode se transformar em um verdadeiro parágrafo de texto! As empresas estão bastante divididas sobre indicar números de versão e lançamento nas capas— algumas o fazem; outras não. Quase sempre, no entanto, você verá a plataforma indicada—se o produto é para Macintosh, PC, UNIX, e assim por diante.
A contracapa dos guias e manuais impressos geralmente é muito simples. Normalmente, contém o número do pedido do livro, o nome da empresa com os símbolos de marca registrada apropriados, um símbolo de copyright e uma frase sobre a propriedade do livro, além de uma declaração sobre qual país o livro foi impresso. Você também encontrará códigos de barras na contracapa. Veja se seu software pode gerar um código de barras; você apenas acessa a utilidade de código de barras e digita o número do pedido do livro, e a utilidade gera o código de barras.
Página de título
A página de título é tipicamente uma duplicata da capa frontal, mas com certos elementos omitidos. Geralmente, são omitidas a arte, logotipos de empresas ou produtos e slogans. Algumas publicações técnicas omitem a página de título totalmente por causa da duplicação aparentemente desnecessária. (E em uma tiragem de 20.000 cópias, uma única página significa muito!)
Aviso de edição
O aviso de edição é tipicamente a primeira instância de texto regular em uma publicação técnica, embora geralmente esteja em um tipo menor. Ele aparece no verso da página de título. Se o editor técnico estiver adotando a abordagem lean-and-green e eliminando a página de título, o aviso de edição aparecerá no verso da capa frontal.
Ninguém gosta de ler letras miúdas, mas dê uma olhada nas declarações normalmente incluídas em um aviso de edição:
- Data de publicação—Incluído não está apenas o ano, mas às vezes até mesmo o mês em que o livro foi publicado.
- Número da edição—Se o livro é uma primeira, segunda ou terceira edição.
- Aplicabilidade do produto—O aviso de edição geralmente indica a qual plataforma, versão e número de lançamento do produto o livro se aplica.
- Título completo do livro—Mostrado em itálico.
- Isenções de responsabilidade—Chocantemente, os fabricantes de produtos farão declarações no sentido de que não garantem que o livro esteja tecnicamente correto, completo ou livre de problemas de redação, ou que o produto esteja livre de defeitos menores ou que atende às necessidades do cliente. Você também poderá encontrar isenções adicionais além dessas.
- Símbolo e declaração de direitos autorais—Você verá o símbolo de copyright círculo-C e uma declaração avisando os leitores para não copiarem o livro sem permissão.
- Permissões de copyright—O mundo da alta tecnologia muitas vezes se move tão rapidamente que, em vez de criar suas próprias versões de um componente de produto e sua documentação correspondente, as empresas simplesmente compram o código ou o design e os direitos de reimprimir a documentação também. Isso geralmente envolve reconhecimento de direitos autorais no aviso de edição (embora, se houver muito empréstimo, os editores devem ser criativos sobre onde colocar todos esses reconhecimentos).
- Resposta dos leitores—Às vezes, o aviso de edição incluirá algum incentivo para os clientes entrarem em contato com a empresa sobre preocupações com o produto ou a documentação. Instruções sobre como contatar a empresa às vezes são incluídas no aviso de edição. Também é frequentemente incluída uma declaração um tanto antipática de que qualquer comunicação do cliente se torna propriedade da empresa.
- Marcas Registradas—Algumas publicações técnicas listam marcas registradas conhecidas no aviso de edição. Isso inclui tanto as marcas próprias da empresa quanto as marcas de outras empresas mencionadas no livro. Com a explosão de novos produtos no mundo da alta tecnologia, e, portanto, a explosão de marcas registradas, algumas publicações basicamente levantam as mãos e inserem uma declaração simples de que quaisquer referências a nomes de produtos registrados são de propriedade de suas respectivas empresas.
Isenção de responsabilidades
Veja a seção sobre avisos de edição, onde os avisos geralmente ficam escondidos. Se um produto ou sua publicação precisa de uma página inteira apenas para seus avisos, eu não vou comprá-lo!
Marcas Registradas
Embora muitas empresas listem suas próprias marcas registradas e as de outras empresas na aviso de edição, alguns preferem listá-los em uma página separada, logo após o aviso de edição. Essas decisões de colocação são quase estritamente da competência dos advogados da empresa; como escritor, você pode ter que se conformar, não importa quão ruim a decisão seja em termos de design do livro ou estilo de escrita. Lembre-se, você lista apenas os nomes de produtos registrados que ocorrem naquele livro específico.
Você notará que algumas publicações adotam medidas extremas com marcas registradas: elas usam asteriscos ou notas de rodapé na primeira, ou até mesmo em cada ocorrência de um nome de produto registrado. Mas, novamente, essas são diretrizes dos advogados da empresa às quais os redatores técnicos devem se resignar, por mais triste que seja.
Garantias
Mais questões legais. Estas são as "garantias" que a empresa oferecerá em relação ao seu produto. Às vezes, estas são publicadas na parte inicial do livro; mas, de maneira mais apropriada do ponto de vista do design do livro, são impressas em um cartão separado e inseridas na embalagem do livro ou do produto. Mais uma vez, assim como com os avisos de edição, este é um texto que você simplesmente traz como "padrão" e posiciona no lugar certo dentro do livro.
No entanto, você deve estar ciente de que as empresas às vezes mantêm várias versões de avisos de edição, avisos de segurança, garantias, declarações de comunicação e outros similares. Como escritor, você deve garantir que está usando a versão correta (e, ao descobrir qual é a correta, você terá a oportunidade de sair e conhecer muitas pessoas novas na empresa!). E, seja o que for que você faça, não mude o texto desses itens padrão, por mais mal escritos que estejam. Mudanças geralmente devem ser aprovadas pelos advogados da empresa (que, normalmente, o fazem relutantemente e apenas após muitos esforços da sua parte e depois que muito tempo se passou).
Avisos de segurança
Os produtos de hardware geralmente têm uma seção de avisos de segurança no início de seus livros. Esses avisos podem aparecer como uma subseção do prefácio, por exemplo, ou como uma seção separada por si só. Essas seções geralmente reúnem todos os avisos de perigo, advertência e precaução que ocorrem ao longo do livro e os organizam de maneira lógica. Mas mesmo com esse alerta inicial, os livros de hardware ainda colocam os avisos individuais nos pontos em que se aplicam. (Para mais informações, veja avisos especiais.)
Declarações de comunicação
Os livros de hardware também exigem declarações de comunicação conforme estipulado pelos governos dos países para os quais esses produtos são enviados. Nos EUA, a FCC exige certas declarações de comunicação dependendo da "classe" do produto de hardware. Como escritor, você deve ter cuidado para usar a declaração de comunicação correta para o produto que está documentando—e não editar a declaração de forma alguma (palavras legais sagradas!).
Índice
O índice (TOC) geralmente contém pelo menos um segundo nível de detalhe (os cabeçalhos 1 no texto real) para que os leitores possam encontrar o que precisam com mais precisão. Escritores, editores e designers de livros costumam discutir a sequência do TOC. Em termos de usabilidade, é muito melhor ter o TOC o mais próximo possível do início do livro, se não na parte bem inicial do livro. Em termos de legalidade, no entanto, as pessoas se preocupam que todas essas declarações de comunicação, garantias, direitos autorais, marcas registradas e avisos de segurança devem vir primeiro. Nos lugares onde a usabilidade prevalece, os livros usam todas as táticas que podem para colocar esse material legalista fora da parte introdutória: garantias são colocadas em cartões separados e embrulhadas a vácuo com o livro ou produto; garantias, declarações de comunicação, marcas registradas e outros assim podem ser jogados em apêndices.
Dificuldade em criar um TOC bem formatado? Veja Crie um índice com aparência profissional
Lista de figuras
Manuais técnicos para usuários comuns geralmente não têm listas de figuras. Na verdade, as figuras em si normalmente não têm títulos completos. Mas isso não significa que uma lista de figuras não tenha lugar em manuais técnicos. Tudo depende do leitor e das necessidades do leitor— e do conteúdo do livro também. Se o livro contém tabelas, ilustrações, gráficos, gráficos e outros itens que os leitores quererão encontrar diretamente, a lista de figuras é necessária.
Prefácio
A função do prefácio é preparar os leitores para ler o livro. Ela faz isso:
- caracterizando o conteúdo e o propósito do livro
- identificando ou até mesmo descrevendo brevemente o produto que o livro apoia
- explicando o tipo de leitor para quem o livro é destinado
- esboçando o conteúdo principal do livro
- mostrando quaisquer convenções ou terminologia especial utilizada no livro
- fornecendo suporte e números de marketing, e outras coisas assim
Na publicação de livros tradicional, o prefácio vem antes do índice; mas como discutido anteriormente no sumário na seção, as pessoas de publicação técnica querem que o índice venha mais cedo no livro por razões de usabilidade.
Capítulos do corpo
Oh sim, e há texto de fato nesses livros—não é tudo material preliminar! Pouco mais a dizer aqui, além de que a maioria dos livros técnicos tem capítulos ou seções, e, em alguns casos, partes. Veja o capítulo sobre design de página para questões de formato, estilo e design de elementos como cabeçalhos, rodapés, títulos, listas, avisos, tabelas, gráficos, referências cruzadas e destaque.
Apêndices
Como você sabe, apêndices são para material que simplesmente não parece se encaixar na parte principal de um livro, mas que não pode ser deixado de fora do livro. Apêndices costumam ser o lugar para grandes tabelas difíceis de manusear. Algumas publicações técnicas têm coisas como garantias nos apêndices. Em termos de formato, um apêndice é como um capítulo, exceto que é nomeado "Apêndice A" ou algo assim, e os cabeçalhos e rodapés correspondem a essa numeração e convenção de nomenclatura diferentes (A-1, A-2, e assim por diante para as páginas do Apêndice A).
Glossário
Algumas publicações técnicas incluem uma seção de termos especializados e suas definições. Observe que a maioria dos glossários usa um layout de duas colunas. Normalmente, cada termo e sua definição formam um parágrafo separado, com o termo em letras minúsculas (a menos que seja um nome próprio) e em negrito, seguido por um ponto, e a definição em letras romanas normais. Note também que as definições normalmente não são frases completas. Boas definições de glossário devem usar a técnica de definição de frase formal conforme descrito em o capítulo de definição do texto online. Múltiplas definições são normalmente identificadas por números árabes entre parênteses. Os parágrafos do glossário também contêm Veja referências a termos preferidos e Veja também referências a termos relacionados.
Índice
Os índices também são tipicamente de duas colunas e também contêm Ver referências a termos preferenciais e Veja também referências a termos relacionados. Veja o capítulo sobre indexação para processos e diretrizes para criar bons índices.
Formulário de resposta do leitor
Antes da ascensão da Internet e das mídias sociais, algumas publicações técnicas continham um formulário impresso para permitir que os leitores enviassem comentários, perguntas e avaliações do livro. Claro, descobriu-se que esses formulários frequentemente geravam reclamações sobre falhas no funcionamento do produto que o livro documenta. Com a ascensão da Internet, esses formulários foram para o online, e os livros apenas apontam para sua localização na internet.
Design e layout de livros
Normalmente, os manuais e guias do usuário produzidos por fabricantes de hardware e software são projetados de maneira bastante austera e espartana. Empresas de alta tecnologia desenvolvem novas versões e lançamentos de seus produtos às vezes a cada nove meses. Nesse contexto, um design sofisticado simplesmente não é prático. Aqui estão alguns dos recursos típicos de layout e design que você verá:
- O tamanho da página é frequentemente determinado por considerações de embalagem, bem como pelos tamanhos padrão de página disponíveis nas empresas de impressão. Quando o tamanho da página não é uma restrição, algumas empresas usarão o tamanho de página de 8,5 × 11 polegadas— isso torna a produção muito mais fácil para os escritores.
- As páginas são tipicamente projetadas com alternância entre páginas direitas e esquerdas. O rodapé da página esquerda (par) começa com o número da página e termina com o título do livro. O rodapé da página direita (ímpar) começa com o título do capítulo e termina com o número da página.
- A prática varia se a numeração das páginas deve ser consecutiva ao longo do livro ou por capítulo.
- A menos que as páginas sejam bastante pequenas, o design de cabeçalhos suspensos em relação às páginas é bastante comum em manuais técnicos. O recuo suspenso é geralmente de uma a uma polegada e meia.
- As fontes costumam ser Times New Roman tamanho 12 para o texto do corpo e Arial para os títulos. O espaçamento padrão entre linhas e palavras é utilizado. Consulte o capítulo sobre destacando para outros problemas tipográficos.
- As margens são bastante padrão, de uma a duas polegadas ao redor. Normalmente, é utilizada uma meia polegada extra nas margens internas para permitir a encadernação.
- Tipicamente, a cor é não usado nestes manuais e guias, geralmente por motivos de custo e eficiência.
Nota: Isso conclui a discussão sobre o livro impresso. componentes. Para completar esta visão geral do design de livros impressos, veja o capítulo sobre design de página, que cobre elementos como cabeçalhos e rodapés, títulos, listas, avisos especiais, tabelas, gráficos, destaque, referências cruzadas e mais.
Agradeceria seus pensamentos, reações, críticas em relação a este capítulo: sua resposta.
