# Ajuda e documentação Aprendizagem, consulta, pesquisa e ajuda contextual orientadas às tarefas. Página: https://resumos.rgo.pt/cadeiras/ipc/ajuda-documentacao/ Uma pessoa que nunca reservou precisa de aprender o processo, enquanto outra, que o usa diariamente, pode só precisar de recordar o limite de cancelamento. Um único manual longo não responde igualmente bem às duas situações. ## Escolher o apoio | Apoio | Necessidade | Exemplo | | --- | --- | --- | | Tutorial/guia inicial | Aprender uma sequência com contexto | Primeira reserva com explicação das etapas | | Manual de utilização | Compreender tarefas e possibilidades | Como escolher, alterar e cancelar reservas | | Referência completa | Consultar detalhes definidos | Estados da reserva, regras e formatos | | Referência rápida | Recordar informação conhecida | Limites, atalhos e passos resumidos | | Ajuda contextual | Resolver uma dúvida no ponto de uso | Explicar que horários podem ser escolhidos | Compara os dois textos para a mesma função de cancelamento: o guia inicial diz “Para cancelar, abre a tua reserva, escolhe Cancelar e confirma; podes fazê-lo até 30 minutos antes do início”, enquanto a referência rápida diz apenas “Cancelamento: até 30 min antes”. O primeiro ensina o percurso a quem ainda não o conhece; o segundo recorda o detalhe a quem já conhece os conceitos. O formato segue a tarefa e o conhecimento do leitor. ## Navegar ou pesquisar Ao navegar, a pessoa explora categorias e precisa de orientação, com nomes claros, hierarquia e caminhos de regresso; ao pesquisar, formula termos e precisa de resultados relevantes, alternativas de vocabulário e pistas para escolher. Uma pesquisa estruturada usa campos ou facetas, como tipo de sala e edifício, enquanto uma pesquisa guiada conduz escolhas quando existe uma sequência útil de decisões; nenhuma obriga a pessoa a conhecer nomes internos da aplicação. Se a pesquisa por “desmarcar” não encontra o artigo “Cancelar reserva”, o vocabulário do utilizador e o da documentação estão desencontrados; podemos associar termos e mostrar resultados com resumo da tarefa. Se não há resultados, preserva a pesquisa e sugere reformulações concretas: perante “desmarcar”, mostra “Cancelar reserva: como anular até 30 minutos antes” e sugere “experimenta cancelar ou anular”. ## Ajuda contextual sem bloquear Coloca a informação necessária junto da decisão e permite consultar mais detalhe: uma etiqueta persistente identifica o campo, uma instrução curta explica a restrição e uma mensagem de erro descreve o problema depois de ocorrer. Estes elementos não são intercambiáveis. Um tooltip que só aparece com o rato não é suficiente para informação essencial, e uma ajuda que tapa o campo ou rouba foco durante a escrita pode impedir a tarefa que devia apoiar. A ajuda deve ser disponível, precisa, consistente e discreta, com comportamento robusto. ## Exemplo resolvido O serviço permite cancelar até 30 minutos antes da reserva, mas a interface mostra apenas “Operação inválida” ao tentar cancelar 10 minutos antes; a pessoa não conhece a regra nem sabe o que aconteceu. A ajuda aparece em dois momentos: antes da decisão, a regra junto da reserva, e depois da tentativa, a explicação da restrição. ![A informação do limite aparece antes da ação. Se a restrição impede cancelar, a mensagem explica a condição e o apoio disponível.](https://resumos.rgo.pt/cadeiras/ipc/ajuda-documentacao/figura-1.svg) Propomos mostrar a regra antes da decisão e, no erro, indicar “Já faltam menos de 30 minutos; o cancelamento nesta aplicação está encerrado” e o apoio realmente disponível, sem prometer um reembolso nem uma exceção que o sistema não oferece. Para avaliar, pede a uma pessoa que descubra até quando pode cancelar e observa se encontra e interpreta a regra, e depois verifica a reação ao caso fora do prazo. Contar que há uma página de Ajuda não mede se ela é encontrável ou útil. ## Manter a documentação Uma ajuda desatualizada pode induzir uma operação errada, por isso a documentação deve acompanhar mudanças de conceitos, fluxos e mensagens, com ligações entre tarefa, interface e referência. Avalia precisão e cobertura face às perguntas que as pessoas precisam de resolver. Uma interface confusa deve ser redesenhada em primeiro lugar: se a pessoa precisa de ler várias páginas para interpretar um botão frequente, o problema está no desenho. Em separado, algumas tarefas complexas continuam a precisar de apoio mesmo com uma interface bem concebida, como regras de cancelamento com exceções. Distingue remediar o desenho de documentar complexidade real. ## Exercícios Desmarcar não encontra cancelar A pesquisa por desmarcar não encontra a página Cancelar reserva. Explica a falha e duas melhorias avaliáveis. Pista A pessoa pode usar um termo legítimo diferente do título. Solução Associa desmarcar e cancelar e apresenta título/resumo que mostre a tarefa. Num teste, pede descobrir como desmarcar uma reserva e observa sucesso e interpretação. Preserva a pesquisa e dá alternativas úteis quando não há resultados. Confere a tua resposta: * Relaciona vocabulário do utilizador com indexação/terminologia. * Propõe associar termos e apresentar resultados/resumos claros. * Define uma tarefa para observar se encontra e interpreta a ajuda. Erros frequentes Não resolver apenas dizendo que o utilizador deve decorar o termo oficial. [Voltar à explicação](https://resumos.rgo.pt/cadeiras/ipc/ajuda-documentacao/#navegar-ou-pesquisar) Quando explicar o prazo A regra “cancelar até 30 minutos antes” só aparece num tooltip ao passar o rato. A reserva começa às 15h e uma pessoa tenta cancelá-la às 14h50. Redesenha a ajuda antes e depois da tentativa, e propõe uma verificação. Pista A pessoa conhece a restrição antes de decidir? Solução Mostra a regra junto da reserva, por exemplo “Podes cancelar até às 14h30”, com detalhe consultável por teclado e toque. Às 14h50, informa que o cancelamento nesta aplicação está encerrado e indica só o apoio realmente disponível. Pede a participantes descobrir até quando podem cancelar e interpretar o caso fora do prazo; observa se encontram e compreendem a informação. Confere a tua resposta: * Apresenta a regra junto da reserva antes da ação e conserva informação legível com teclado e toque. * Propõe mensagem específica depois da tentativa fora do prazo, sem prometer uma exceção. * Define uma tarefa que verifica encontrar e interpretar a regra. Erros frequentes Não resolver escondendo a mesma regra noutro tooltip. Não prometer reembolso nem nova reserva automática sem suporte do serviço. [Voltar à explicação](https://resumos.rgo.pt/cadeiras/ipc/ajuda-documentacao/#ajuda-contextual-sem-bloquear)