Um manual por versão ou um manual único: qual publicar
Quando o software muda, a documentação precisa acompanhar. Uma opção é publicar um manual separado para cada versão. A outra é manter um manual único que cobre todas as versões e marca o que difere. Cada uma tem um custo: manuais separados multiplicam os arquivos a manter, enquanto um manual único pode confundir quem precisa de uma só versão. A melhor escolha depende de quantas versões estão em uso ao mesmo tempo.
Visão rápida
| Aspecto | Um manual por versão | Um manual único |
|---|---|---|
| O que o leitor recebe | Exatamente as páginas da sua versão. | Um documento que explica todas as versões. |
| Manutenção | Mais arquivos para atualizar e arquivar. | Um arquivo, mas com notas sobre o que mudou. |
| Risco de confusão | Baixo, se a versão estiver no nome do arquivo. | Maior, se as notas de versão forem pouco claras. |
| Tamanho do arquivo | Cada arquivo fica pequeno. | Um arquivo grande. |
| Como preparar | Dividir ou extrair as páginas de cada versão. | Reunir as partes e criar um marcador por versão. |
Decida pelo número de versões em uso
Se os clientes usam várias versões ao mesmo tempo e as diferenças são grandes, um manual por versão é mais claro, pois cada leitor vê só o que se aplica. Se a maioria migra rápido para a versão mais nova e as mudanças são pequenas, um manual único com marcações claras de versão é mais fácil de manter. Seja qual for a escolha, coloque a versão e a data na capa e no nome do arquivo.
Quando escolher cada um
Um manual por versão
Escolha um manual por versão quando várias versões estão em uso e diferem bastante.
Um manual único
Escolha um manual único quando as versões são próximas e a maioria dos usuários está em dia.
Ferramentas gratuitas para as duas opções
Guias que colocam o termo em prática
- Dividir um PDF por capítulosPasso a passo: descubra onde cada capítulo começa, digite os intervalos de páginas, baixe um ZIP com um PDF por capítulo e extraia páginas soltas quando precisar.
- Páginas-chave de um PDF longoPasso a passo: escolha as páginas que importam em um relatório longo, coloque-as em ordem lógica, junte trechos de vários arquivos e identifique cada página com a origem.
- Marcadores em PDF longoPasso a passo: numere as páginas, liste os capítulos, crie marcadores clicáveis para o leitor pular até cada um, teste o painel lateral e deixe o arquivo pronto para a web.
Termos de PDF explicados
- Divisão de PDFDividir um PDF corta um documento em arquivos menores, por página ou por intervalo. Veja como funciona, quando usar e o que conferir depois.
- Marcadores de PDF (sumário lateral)Os marcadores de PDF formam um sumário clicável no painel lateral do leitor. Veja como esse sumário funciona, como difere de links e quando vale a pena adicioná-lo.
- Versionamento de documentosVersionar um documento é manter cada revisão como uma cópia separada e bem identificada. Veja hábitos simples de nomeação, por que a data ajuda e como enxergar o que mudou.
Perguntas frequentes
- Posso começar com um manual único e dividir depois?
- Sim. Mantenha o arquivo completo e, quando surgir a necessidade, divida por capítulos ou extraia as páginas de cada versão.
- Como ajudo o leitor a achar a sua versão?
- Coloque a versão no nome do arquivo e na capa e, em um manual único, crie um marcador para cada versão.
- Quais das suas ferramentas cuidam disso?
- Juntar PDF une as partes em um só manual, Dividir PDF por capítulos separa um manual longo em capítulos e Extrair páginas do PDF copia as páginas de uma versão para um arquivo novo. Cada ferramenta salva um arquivo novo e mantém o original como estava. O AuraDoc não decide quais páginas pertencem a qual versão.