Um excelente manual de utilizador de software transforma utilizadores confusos em utilizadores confiantes. Com a Trupeer, pode poupar horas na criação de documentação de software ao começar com um modelo de manual de utilizador de software gratuito, personalizá-lo com as suas diretrizes de marca e utilizar o nosso criador de manuais com IA para transformar walkthroughs do produto em manuais de vídeo bem acabados.

O que é um modelo de manual de utilizador de software gratuito?

Um modelo de manual de utilizador de software gratuito é uma estrutura reutilizável para um documento completo e versionado que descreve como utilizar uma peça de software, produzido como uma entrega em vez de como um website vivo.

Essa diferença é a razão pela qual este documento ainda existe num mundo de páginas de ajuda. Os manuais são produzidos quando a documentação tem de ser completa, fixa e autónoma: software entregue no local, produtos vendidos em ambientes regulamentados, sistemas a funcionar em redes sem acesso externo e contratos em que um manual é uma entrega identificada.

Se o seu software for um produto alojado e os seus utilizadores acederem à documentação através de um motor de pesquisa ou de uma ligação de ajuda no produto, então quer uma página de ajuda em vez de um manual, e a página do manual de utilizador de software explica como isso deve ser estruturado.

O modelo não é o manual. As listas de secções para manuais são amplamente publicadas e, em grande medida, intercambiáveis. O que determina se um manual funciona na prática é como lida com o problema abaixo, que páginas de ajuda nunca enfrentam e que quase nenhum modelo aborda.

O formato segue a entrega. Um ficheiro Word de modelo de manual de utilizador de software gratuito é onde estas coisas são escritas e revistas. Um modelo de manual de utilizador de software gratuito em PDF é o que é enviado, porque um manual é um registo fixo e um PDF é o único formato comum que se comporta como tal. Um layout de PPT de modelo de manual de utilizador de software gratuito serve para formações derivadas do manual, e um ficheiro Excel de modelo de manual de utilizador de software gratuito serve para o inventário de conteúdos por trás, em vez do documento.

Um manual é um instantâneo; uma página de ajuda é um fluxo

Uma página de ajuda tem uma única versão: a atual. Quando o software muda, a página muda e cada leitor vê a nova página. As versões antigas não persistem porque existe apenas uma cópia.

Um manual comporta-se de forma oposta. O produz, envia-o e, a partir desse momento, as cópias existem independentemente de si. Ficam em servidores de ficheiros do cliente, em pastas impressas, anexadas a emails antigos e dentro de registos de procurement. Não os pode atualizar e, frequentemente, nem sequer consegue saber quem tem cada cópia.

Entretanto, o software avança. Em poucos anos, tem uma base de clientes distribuída por muitas versões, todos a ler documentos produzidos em momentos diferentes, e sem uma forma fiável de saber que documento cada leitor está a utilizar.

Este é o problema definidor de um manual de software e está totalmente ausente numa página de ajuda. Todas as decisões de design abaixo decorrem disso.

Como personalizar este modelo na Trupeer

Passo 1: Abra a secção Templates

Vá à secção Templates no menu principal.

Passo 2: Selecione e abra um modelo

Clique em qualquer modelo com que queira trabalhar para o abrir.

Passo 3: Expanda a visualização do modelo

Se necessário, expanda a visualização do modelo para ver o layout completo e os detalhes com clareza.

Passo 4: Edite o modelo

Clique em Edit para começar a modificar o modelo selecionado.

No editor, pode:

• Adicionar novas secções

• Definir ou atualizar regras de formatação

• Adicionar um logótipo e ajustar a sua posição e definições relacionadas

Passo 5: Guarde o seu modelo personalizado

Depois de fazer todas as alterações necessárias, clique em Save para guardar o modelo atualizado como seu.

Passo 6: Pré-visualize e ajuste o modelo

Quando quiser ver como fica o seu modelo personalizado, abra o Preview.

A partir do ecrã de pré-visualização, pode continuar a fazer ajustes diretamente, se necessário, garantindo que o modelo aparece exatamente como o pretende.

Com um modelo de manual de utilizador de software pode:

• Poupar horas na escrita: Ignore a página em branco com uma estrutura criada para documentação de software.

• Reduzir pedidos de suporte: Manuais claros ajudam os utilizadores a resolverem por si — reduzindo significativamente os pedidos.

• Manter-se alinhado com a marca: Aplique o seu logótipo, fontes e cores usando o brand kit da Trupeer.

• Melhorar a adoção: Os utilizadores que compreendem o seu software utilizam-no mais — e ficam por mais tempo.

• Adicionar walkthroughs em vídeo: Incorpore vídeo para passos difíceis de explicar em texto.

• Atingir utilizadores globais: Traduza manuais de utilizador para 65+ idiomas com um único clique.

O problema das versões e o que fazer a respeito

Três falhas voltam a repetir-se e todas as três são baratas de prevenir no momento da escrita.

O leitor não sabe a que versão o seu manual se refere. Quase todos os manuais trazem a versão na capa e em mais nenhum sítio. Um leitor que abre um PDF e faz uma pesquisa dentro dele, que é o que as pessoas fazem, chega à página noventa e quatro e nunca vê a capa. Coloque a versão do software no rodapé de todas as páginas. Custará apenas um campo num modelo e elimina a forma mais comum do problema.

O leitor não sabe que versão está a utilizar. Diga como verificar, nas primeiras páginas, numa única linha. A maioria dos manuais assume que o leitor sabe e muitos utilizadores não sabem.

O manual não indica quando uma funcionalidade apareceu. Um leitor numa versão mais antiga segue uma instrução para algo que ainda não existe, conclui que o software está avariado e contacta o suporte. Marque as funcionalidades com a versão em que foram introduzidas e marque tudo o que tenha mudado de comportamento com a versão em que essa mudança ocorreu. É mais trabalho do que as outras duas, mas evita falhas dispendiosas.

Adicione mais uma coisa, que não tem a ver com o leitor, mas consigo. Mantenha todas as versões publicadas do manual disponíveis no seu site de suporte, em vez de apenas a mais recente. Um cliente numa versão mais antiga precisa do manual dessa versão e, ao alojar apenas a versão atual, garante-se que vai utilizar o documento errado.

O que um manual de utilizador de software tem de conter

Dez componentes. Os dois primeiros e os dois últimos são o que distingue um manual de uma página de ajuda.

O requisito de completude vale a pena ser dito explicitamente. Um manual não pode ligar para conteúdo vivo para qualquer coisa de que um leitor genuinamente precise, porque pode ser lido num ambiente sem acesso à rede ou depois de a página ligada ter mudado. Tudo o que é essencial está dentro do documento.

Modelo de manual de utilizador de software gratuito: a estrutura para copiar

Preenchido com um exemplo real em vez de placeholders. O software é um sistema de informação de laboratório entregue no local.

Copie daqui.

Capa. Nome do produto. Versão do software 11.2. Revisão do manual C. Publicado a 14 de março. Aplica-se apenas às versões 11.0 a 11.2.

Rodapé da página, em todas as páginas. Nome do produto, versão do software 11.2, revisão C, número da página. Esta é a linha única mais útil do documento.

Como verificar a sua versão. Selecione Help e, em seguida, About. A versão aparece como um número, como 11.2.4. Se os seus dois primeiros números não forem 11.2, este manual não descreve o seu sistema e o manual correto para a sua versão está no site de suporte em Documentation Archive.

O que mudou na revisão C. O arquivamento tornou-se reversível na versão 11.0. Nas versões anteriores, o arquivamento é permanente e não pode ser desfeito dentro da aplicação. Veja o capítulo nove. A reetiquetagem de amostras ganhou uma segunda etapa de confirmação na 10.4.

Público-alvo. Equipa do laboratório a realizar manuseamento e reporte de amostras de rotina. Pressupõe que lhe foi atribuído um acesso de utilizador e que concluiu a indução local. Não abrange administração do sistema, que está no manual do administrador.

Como começar. Iniciar sessão, o ecrã principal e concluir um registo de amostra de ponta a ponta.

Capítulos de tarefas. Organizados pelo que as pessoas fazem. Registar amostras. Registar resultados. Fazer reporte. Pesquisar registos históricos. Arquivar. Cada página de tarefa indica o que assume e inclui a aplicabilidade da versão no rodapé.

Marcadores de disponibilidade de funcionalidades. Usados ao longo de todo o documento, na forma: Disponível a partir da versão 10.4. O comportamento mudou na versão 11.0. Estes aparecem ao lado da instrução relevante, e não num apêndice.

Referência. Definições de campos, códigos de estado, mensagens de erro com significados, atalhos de teclado.

Resolução de problemas. Doze entradas retiradas da fila de suporte, cada uma com sintoma, causa provável e resolução.

Índice. Real, cobrindo os termos que os utilizadores utilizam, bem como os termos que a interface utiliza, para que um leitor que procure um reembolso encontre a página da nota de crédito.

Suporte. Telefone, portal, horários e que informação ter pronta. Incluído porque um utilizador que lê isto pode não ter outro canal.

Copie para aqui.

Exemplo de manual de utilizador de software: sessenta e um por cento numa versão diferente

A Denholm Clinical Systems, uma empresa com cerca de cento e vinte pessoas, fornece um sistema de informação de laboratório para hospitais e laboratórios privados. O software é instalado nas instalações do cliente e os clientes fazem upgrade nos seus próprios horários.

O manual tinha duzentas e quarenta páginas, foi produzido como PDF e emitido com cada release. Estava bem escrito e era completo.

O site de suporte alojava um único manual: o mais recente.

Sessenta e um por cento da base instalada estava a executar uma versão mais antiga do que a versão que o manual atual descrevia. Vários sites estavam duas versões principais atrás, o que é pouco surpreendente nesse setor, onde os upgrades exigem validação.

Um laboratório a executar a versão 8.4 precisava de arquivar catorze meses de registos históricos. Abriram o manual atual, a revisão para a versão 11.2, e leram o capítulo de arquivamento. Indicava que os registos arquivados podiam ser restaurados a partir do separador Archive a qualquer momento.

Isso era verdade a partir da versão 11.0. Na 8.4, o arquivamento era permanente.

Arquivaram catorze meses de registos. Não havia restauro. A recuperação exigia restaurar a partir de uma cópia de segurança, o que levou três dias de indisponibilidade do laboratório e um engenheiro do fornecedor no local, e custou cerca de quarenta e seis mil libras entre o trabalho de recuperação e a interrupção. Seguiu-se uma reclamação formal e foi justificada.

Nada no manual estava incorreto. Todas as afirmações nele eram verdadeiras para a versão 11.2. A capa dizia 11.2. O leitor tinha pesquisado o PDF, chegou à página cento e quarenta e um e leu uma instrução correta para um software que não estava a executar.

Foram feitas três alterações e nenhuma foi dispendiosa.

A versão foi colocada no rodapé de todas as páginas. Uma instrução de uma linha sobre como verificar a sua própria versão foi colocada perto do início. As funcionalidades e os comportamentos ganharam marcadores de disponibilidade, pelo que o capítulo de arquivamento passou a indicar que a restauração está disponível a partir da versão 11.0 e que o arquivamento é permanente nas versões anteriores.

A quarta alteração foi o alojamento. Cada revisão de manual publicada foi colocada no site de suporte em documentação archive, para que um cliente na 8.4 pudesse encontrar o manual da 8.4.

Os pedidos de suporte atribuíveis a confusão de versões passaram de cerca de vinte e três por mês para quatro.

O leitor não fez nada de errado. Utilizou o único manual que o fornecedor disponibilizou.

Como escrever um manual de utilizador de software em seis passos

1. Decida se precisa mesmo de um manual. Se os seus utilizadores têm acesso à rede e acedem à documentação por pesquisa, uma página de ajuda serve-os melhor. Os manuais são para documentos enviados, fixos e completos.

2. Corrija primeiro o esquema de versões. Quais as versões do software que este manual abrange e qual é a numeração de revisões do próprio manual. Ambos vão para o rodapé.

3. Estruture por tarefas, não pelo menu. A estrutura do menu do produto descreve como foi construído. Os utilizadores chegam com algo que estão a tentar fazer.

4. Marque a disponibilidade enquanto escreve. Indicar que uma funcionalidade chegou numa determinada versão é trivial durante a escrita e quase impossível de reconstruir depois.

5. Retire a resolução de problemas da fila de suporte. Os seus pedidos mais comuns são o capítulo, já priorizado.

6. Crie um índice real. Incluindo as palavras que os utilizadores dizem, e não apenas as palavras que a interface utiliza. Num documento enviado, o índice é a função de pesquisa.

O passo quatro é o que costuma ser adiado e o que evita as falhas que custam dinheiro.

Quando precisa de um manual em vez de uma página de ajuda

Cinco situações em que um manual é a resposta certa e, fora delas, uma página de ajuda costuma vencer.

Software entregue no local, com upgrades no horário do cliente. Os seus utilizadores estão distribuídos por versões e não podem ser servidos por uma única página atual.

Ambientes sem acesso externo à rede. Instalações seguras, sistemas de controlo industrial, dispositivos médicos, defesa. A documentação tem de estar presente localmente e ser completa.

Produtos regulamentados. Quando a documentação faz parte do que foi avaliado ou certificado, tem de ser fixa, versionada e recuperável. Ambientes validados frequentemente exigem o manual especificamente para a versão validada. Qualquer manual que faça parte de uma submissão regulamentar ou de um produto certificado deve ser revisto face à norma aplicável por uma pessoa qualificada e nada nesta página substitui isso.

Entregas contratuais. Quando um manual é um item nomeado num contrato ou num cronograma de procurement, os requisitos do contrato determinam o formato e o conteúdo.

Produtos em que o utilizador não tem um canal de suporte. Distribuição física, vendas pontuais, equipamento com longa vida útil. O manual é tudo o que terão.

O melhor modelo de manual de utilizador de software gratuito para qualquer uma destas situações é aquele que sobreviver à reemissão quatro vezes por ano. Se nenhuma destas situações se aplicar, a resposta honesta é que está a produzir um manual por hábito e que uma página de ajuda serviria melhor os seus utilizadores e custaria menos a manter.

Manual de utilizador de software, guia de utilizador ou manual de instruções?

Três termos com utilização sobreposta e as diferenças que vale a pena conhecer ao escolher uma estrutura.

Um manual de utilizador de software é completo, versionado e entregue. Assume que o leitor pode não ter mais nenhum recurso e não tem forma de lhe colocar uma questão.

Um guia de utilizador de software é o mesmo conteúdo no formato online, continuamente atualizado, inserido a partir da pesquisa e mantido página a página. Aplicam-se regras estruturais diferentes, abordadas na página do guia de utilizador de software.

Um manual de instruções acompanha normalmente equipamento físico, onde se aplicam conteúdos de segurança, posicionamento de avisos e obrigações legais que a documentação de software não inclui. A página do manual de instruções aborda essa tradição.

Na prática, as equipas frequentemente precisam tanto de um manual como de uma página de ajuda, com o manual gerado a partir do mesmo conteúdo de origem no momento do release. Esta é a configuração a que vale a pena aspirar, porque manter dois conjuntos independentes de documentação produz dois conjuntos que não coincidem.

O que um modelo de manual de utilizador de software gratuito não consegue corrigir

Um manual para muitas versões. Nenhuma estrutura resolve isto. Apenas publicar um manual por versão e manter o arquivo é que resolve.

Um manual que ninguém consegue encontrar. Alojando apenas a revisão mais recente, garante-se que os clientes em versões mais antigas leem o documento errado.

Capturas de ecrã de uma versão anterior. Cada imagem num manual fica associada a uma versão, o que é um argumento para as marcar e para a abordagem de produção abaixo.

Informação de versão que um modelo nunca pediu. Nenhum modelo gratuito de manual de utilizador de software gratuito para download e nenhum modelo gratuito de manual de utilizador de software para download inclui um campo de aplicabilidade de versão, porque os modelos de manual foram concebidos para produtos que não mudam.

Um documento montado a partir de uma página de ajuda sem ajustes. As páginas online assumem que as ligações funcionam e que o conteúdo está atualizado. Ao exportar para um documento fixo, ambas as suposições falham e o resultado parece uma página web impressa, porque é isso mesmo.

Mostre o software em vez de o descrever

Os manuais têm uma carga visual mais pesada do que qualquer outro formato de documentação, por uma razão específica relacionada com a forma como são entregues.

Uma página de ajuda pode ligar para um vídeo. Um manual frequentemente não pode, porque pode ser lido offline, num ambiente seguro ou anos depois de a ligação deixar de funcionar. Por isso, tudo o que o leitor precisa tem de estar dentro do documento, o que significa imagens em vez de ligações, e um manual com duzentas páginas pode conter várias centenas de imagens.

Depois, o problema das versões multiplica isso. Cada imagem fica associada ao release em que foi capturada; por isso, uma nova versão principal significa recapturar o conjunto. É por isso que os manuais muitas vezes são enviados com imagens duas versões desatualizadas e por que os leitores deixam de confiar neles.

A Trupeer AI altera a aritmética. Alguém executa a tarefa uma vez, na versão que está a ser documentada, enquanto grava, e o resultado é um walkthrough escrito passo a passo com imagens já capturadas, anotadas e colocadas, juntamente com um vídeo, na sua própria marca. Produzir o conjunto de imagens para um novo release significa voltar a gravar em vez de voltar a filmar centenas de ecrãs.

Registe. Marque com a sua marca. Traduza. Trupeer.

Há mais dois pontos que importam especificamente para manuais. A versão em vídeo pode acompanhar o manual no site de suporte para clientes que têm acesso à rede, pelo que a mesma produção serve ambos os canais de entrega sem duplicar o trabalho. E quando um produto é enviado internacionalmente, a mesma gravação produz o mesmo conteúdo do manual em cada idioma, o que aqui importa mais do que numa página de ajuda, porque um manual enviado no idioma errado não pode ser corrigido silenciosamente mais tarde.

O material fica na sua base de conhecimento e serve também como formação para equipas de suporte e de implementação. Os procedimentos operacionais de quem executa o software devem ficar no runbook. A consistência entre os seus documentos é uma questão de definir o brand kit uma vez e a configuração é abordada no guia de configuração do template de documento.

Perguntas Frequentes

Existe um modelo de manual de utilizador de software gratuito em Word?

O Word é onde os manuais são escritos, revistos e atualizados, e trata das coisas de que os manuais precisam: uma tabela de conteúdos real, um índice, referências cruzadas, numeração de páginas e rodapés.

O rodapé é a definição que vale a pena acertar. Coloque a versão do software e a revisão do manual no rodapé antes de escrever qualquer coisa, para que todas as páginas os incluam. Um ficheiro Word de modelo de manual de utilizador de software gratuito sem informação de versão no rodapé vai produzir o problema descrito nesta página.

Existe uma versão em Word de modelo de manual de utilizador para uso geral?

Sim, e existem muitos modelos para fins gerais disponíveis. Um ficheiro Word de modelo de manual de utilizador normalmente fornece uma capa, conteúdos, capítulos, resolução de problemas e um índice, o que é uma estrutura razoável.

São necessárias duas adições especificamente para software. A aplicabilidade da versão no rodapé da página e uma forma de marcar quando uma funcionalidade apareceu. Nenhuma destas existe em modelos gerais porque nenhuma é relevante para um documento que descreve algo que não muda.

Existe um modelo de manual de utilizador de software gratuito em PDF?

O PDF é o que é enviado. Escreva num documento e, em seguida, exporte um modelo de manual de utilizador de software gratuito em PDF para entrega, com a versão e a revisão visíveis em todas as páginas, e não apenas na capa.

Dois detalhes de produção. Gere marcadores reais a partir dos seus títulos, já que os leitores navegam em PDFs longos dessa forma. E certifique-se de que o texto é pesquisável e não uma imagem, o que acontece ocasionalmente quando os manuais são montados a partir de ferramentas de design.

Onde posso obter um modelo de manual de utilizador para download gratuito?

Está amplamente disponível, incluindo em organismos de normas e agências públicas, cujas versões tendem a estar melhor estruturadas do que os sites de modelos comerciais, porque foram escritas para serem utilizadas.

Seja qual for o modelo de manual de utilizador para download gratuito com que comece, a primeira edição é o rodapé. A segunda é adicionar uma secção curta perto do início a explicar ao leitor como verificar a versão do software que está a utilizar, o que quase nenhum modelo inclui e que evita o tipo mais comum de contacto relacionado com suporte por causa de manuais.

Existe uma versão em PPT de modelo de manual de utilizador de software gratuito?

Os slides servem para formações construídas a partir de um manual, e não para o próprio manual. Um deck de PPT de modelo de manual de utilizador de software gratuito funciona para uma sessão de onboarding ou para um dia de formação do cliente.

Não é um substituto do documento. Um manual existe para ser completo e pesquisável por alguém que não tem mais nenhum recurso e um deck de slides não é.

Existe uma versão em Excel de modelo de manual de utilizador de software gratuito?

O Excel serve para o inventário por trás do manual, e não para o próprio manual. Um ficheiro Excel de modelo de manual de utilizador de software gratuito funciona bem como registo de conteúdos: uma linha por secção, com o respetivo responsável, a versão em que foi verificado pela última vez, se as imagens estão atualizadas e a que versões do produto se aplica.

Esse registo é o que torna uma atualização de release gerível. Sem ele, atualizar um manual com duzentas páginas para uma nova versão significa reler tudo.

Existe um modelo de manual de utilizador de software gratuito para download que valha a pena usar?

A lista de secções demora meia hora a construir e a maioria dos modelos publicados é quase idêntica, por isso um modelo de manual de utilizador de software gratuito para download não está a poupar muito.

Avalie qualquer um deles com uma pergunta. Tem um lugar para a aplicabilidade da versão na página, e não apenas na capa? Essencialmente nenhum o faz, porque a maioria dos modelos de manual foi concebida para produtos que não mudam e o software muda.

Qual é o melhor modelo de manual de utilizador de software gratuito?

O melhor modelo de manual de utilizador de software gratuito é aquele em que consegue colocar um rodapé de versão e manter isso ao longo dos releases, o que na prática significa um documento simples em vez de um documento desenhado.

Os modelos muito desenhados ficam melhores, mas são consideravelmente mais difíceis de atualizar e um manual que é doloroso de atualizar é um manual que é enviado a descrever o release anterior. Para um documento reemitido várias vezes por ano, a manutenibilidade supera a aparência.