Ajuda

Use a Ajuda como um mecanismo secundário para ajudar os usuários a concluir e entender melhor as tarefas, sendo o mecanismo principal a própria interface do usuário. Aplique estas diretrizes para tornar o conteúdo realmente útil e fácil de encontrar.

Um sistema de Ajuda é composto por vários tipos de conteúdo projetados para ajudar os usuários quando eles não conseguem concluir uma tarefa, querem entender um conceito com mais detalhes ou precisam de mais detalhes técnicos do que os disponíveis na interface do usuário.

Neste artigo, referimo-nos à Ajuda como secundária à IU. A interface do usuário é primária porque é onde os usuários primeiro tentam resolver seus problemas. Eles consultam o sistema de Ajuda somente se não puderem realizar suas tarefas com a interface do usuário.

A home page de Ajuda e Suporte do Windows, disponível no menu Iniciar.

Note: Guidelines related to style and tone are presented in a separate article.

Esta é a interface de usuário correta?

Para decidir, considere estas questões:

• Quão motivados estão os seus utilizadores-alvo? Quanto mais motivados estiverem para descobrir a funcionalidade do seu programa e tornarem-se utilizadores intermédios ou mesmo avançados do mesmo, mais dispostos estarão a pesquisar respostas às suas perguntas consultando tópicos da Ajuda.
• Você está usando a Ajuda para corrigir uma interface do usuário incorreta? Quanto melhor for a sua IU, menos utilizadores procurarão ajuda adicional. Se o seu programa tiver uma interface do usuário primária muito clara e útil (como mensagens de erro sem jargões, assistentes bem escritos e caixas de diálogo inequívocas), talvez você não precise de um sistema de Ajuda secundário.
• O seu programa é relativamente simples? Em caso afirmativo, considere incorporar todo o conteúdo de assistência necessário em suas superfícies principais da interface do usuário. Os usuários são mais propensos a procurar ajuda adicional em programas que executam tarefas complexas.
• Seu aplicativo é destinado a desenvolvedores, profissionais de TI ou outros especialistas em software? Esses usuários tendem a esperar Ajuda de referência para convenções de linguagem de programação e Ajuda conceitual aprofundada para o domínio de recursos.

Conceitos de design

Se decidir incluir a Ajuda no seu programa, integre-a no seu design geral. A interface de Ajuda deve ser simples, eficiente e relevante; Ele deve permitir que os usuários obtenham ajuda facilmente e, em seguida, retornem à sua tarefa. Pense no seu sistema de Ajuda em termos de tempo dos usuários: minimize as interrupções primeiro antecipando onde eles encontrarão problemas em seu programa, depois resolvendo esses problemas incorporando assistência fundamental diretamente em sua interface do usuário e criando pontos de entrada claros e consistentes em sua Ajuda mais detalhada.

A assistência do Windows foi concebida de acordo com estes princípios. Aqui estão algumas das alterações de design para a experiência do usuário da Ajuda do Windows:

• More discoverable entry points to Help from the primary UI (especially new Help links from UI surfaces such as dialog boxes, error messages, and wizards). Os links de Ajuda levam você diretamente ao tópico pertinente na Ajuda.
• Um ícone do botão Ajuda está disponível no canto superior direito da maioria das páginas de hub do Painel de Controle, bem como pastas de shell.
• Users can choose to get the most up-to-date Help content from Windows Online Help and Support when they're online.
• Os tópicos da Ajuda agora são baseados em tarefas, em vez de focados em recursos, para que os usuários possam realizar suas tarefas de forma rápida e eficiente.
• Os tópicos da Ajuda agora são amplamente baseados em cenários conhecidos dos principais usuários.
• Help topics have a more relaxed and informal tone, using real-world language.
• Os tópicos da Ajuda são projetados para uma leitura rápida, já que os utilizadores raramente leem o conteúdo palavra por palavra.

An analogy for Help

Para pensar mais profundamente sobre como projetar seu sistema de Ajuda, considere uma analogia da vida cotidiana. Você está perdido em uma cidade desconhecida. O que tu fazes? Muitos reagiriam assim:

• Oriente-se; Procure pontos de referência, sinais de rua (nomes e indicações para lugares).
• Procure mapas.
• Finalmente, como último recurso, peça instruções ou ligue para um amigo.

O projeto da "interface" da cidade afeta a tua necessidade de assistência. Ruas bem identificadas, direções explícitas (indicações para hospitais, aeroportos, museus e correios) e pontos de referência claros, como características geográficas proeminentes ou edifícios, ajudam você a encontrar o caminho.

Você pede ajuda como último recurso. É um indício de que a "interface" da cidade falhou por ser mal desenhada e confusa. É mais provável que peça ajuda num local que tenha um rótulo específico que sugira utilidade. Por exemplo, é mais provável que você peça ajuda em um lugar rotulado como "Direções" ou "Informações" do que em um lugar geral como a Prefeitura, embora praticamente qualquer pessoa na Prefeitura possa lhe dar instruções.

Quando você pede ajuda, é provável que você esteja frustrado e só queira chegar ao destino pretendido. Você provavelmente não está com vontade de gastar tempo fazendo um tour pela cidade ou aprendendo sobre sua história. Além disso, a sua motivação depende da importância da tarefa. If you are trying to find your hotel room, you will do whatever it takes. No entanto, se o seu objetivo é encontrar um lugar de menor importância, muito provavelmente você vai desistir depois de um esforço modesto.

Todos esses aspetos de encontrar o seu caminho no espaço real correspondem a como os usuários normalmente encontram seu caminho no espaço virtual do seu programa. Procurar ajuda para além da IU primária é, por natureza, desorientador; faça o seu melhor para mitigar essa experiência com uma interface do usuário bem projetada e "sinais de rua" inteligentes para direcionar os usuários para as respostas de que precisam.

Projetando a interface do usuário para que a Ajuda seja desnecessária

Tente tornar a Ajuda desnecessária em primeiro lugar, ao:

• Tornando as tarefas comuns fáceis de descobrir e executar.
• Providing clear main instructions.
• Fornecer rótulos de controle claros e concisos que são orientados para objetivos e tarefas.
• Fornecer instruções e explicações suplementares, quando necessário.
• Antecipar problemas evitáveis usando controles restritos a escolhas válidas, fornecendo valores padrão adequados, manipulando todos os formatos de entrada e prevenindo erros.
• Escrever mensagens de erro que forneçam uma solução ou ação clara para o usuário tomar.
• Evitar designs de interface do usuário confusos, como tarefas com fluxo insatisfatório ou o uso de controles desativados sem motivo aparente.
• Trabalhar com escritores e editores no início do ciclo de desenvolvimento para criar texto de interface de utilizador consistente e de alta qualidade ao longo do programa.

Os usuários não devem ter que ir a outro lugar para descobrir como usar sua interface do usuário. Adicione informações essenciais diretamente à interface do usuário principal, em vez de forçar os usuários a saírem do contexto imediato e entrarem no painel de Ajuda. Se as informações importantes existirem apenas em um tópico da Ajuda, há uma boa chance de que os usuários não as vejam. Para obter informações opcionais e mais explicativas, use os links da Ajuda da interface do usuário principal para o tópico da Ajuda relevante para obter assistência suplementar.

Considerando a motivação do usuário

Para a maioria dos usuários, velocidade e eficiência estão entre as virtudes primordiais de bons programas. Os utilizadores querem fazer o seu trabalho. Geralmente, eles não estão interessados em aprender sobre o programa e a tecnologia por si só; A sua paciência só se estende na medida em que esse programa sirva os seus próprios interesses e resolva os problemas em questão.

Projete seu sistema de Ajuda para corresponder à motivação de seus usuários. Por exemplo, considere um usuário que passeou até um quiosque em um museu. Se ela não conseguir descobrir como executar a tarefa rapidamente, é provável que desista e vá embora. É improvável que ela passe algum tempo usando a Ajuda. Alternativamente, um usuário altamente motivado tem uma maior tolerância ao tempo gasto pesquisando seu sistema de Ajuda para obter respostas. Um usuário de negócios que precisa equilibrar as contas, por exemplo, provavelmente está disposto a consultar o conteúdo da Ajuda para tirar o máximo proveito desse novo aplicativo de contabilidade.

Writing content for scanning

Escreva tópicos da Ajuda sabendo que eles serão verificados em busca de informações específicas, e não lidos palavra por palavra. Escreva de forma concisa, chegando ao ponto rapidamente e fornecendo informações sobre as quais os usuários possam agir.

• Escreva tópicos de "instruções" usando etapas numeradas em um formato consistente para que os usuários reconheçam que estão recebendo assistência processual.
• Escreva tópicos de referência com facilidade de varredura em mente, usando tabelas, por exemplo, para apresentar opções de interface do usuário ou sintaxe de idioma.
• Escreva tópicos conceituais que são organizados logicamente por subtítulos, para que o usuário possa pular seções inteiras de menor interesse.

In all Help content, it is easier to scan bulleted lists than standard paragraph blocks of text; use bullet lists judiciously, though, not as a crutch for unorganized material.

Criação de conteúdo importante

Dado que nenhum sistema de Ajuda pode antecipar todas as perguntas que cada usuário possa ter, concentre a maior parte do conteúdo em responder às principais perguntas nos principais cenários para seus usuários-alvo. Por exemplo, uma pesquisa eficaz e como estabelecer conectividade de rede (entre outras tarefas) podem ser tópicos muito procurados. Além disso, concentre-se em tarefas dentro de seus principais cenários de usuário, em vez de documentar um recurso ou tecnologia exaustivamente por si só.

Dica: O suporte técnico é uma boa fonte de conteúdo de Ajuda. Os suportes técnicos geralmente mantêm registros de perguntas frequentes sobre programas ou tarefas específicos que os usuários estão tentando (e falhando) em realizar.

Não é necessário fornecer ajuda para todos os recursos da interface do usuário. Quite often, unhelpful Help results from trying to create Help for everything. Se a interface do usuário for bem projetada, a maioria desses tópicos da Ajuda não será muito útil; limitar-se-ão a reafirmar o óbvio.

Se houver mais de uma maneira de executar uma tarefa, na maioria dos casos, você pode apenas documentar a maneira mais comum usada por usuários inexperientes. Exceptions to this include accessibility considerations (documenting keyboard equivalents of mouse actions, for example), and platform considerations (documenting for the tablet form factor, for example, or for server environments in which the command line can substitute for the graphical user interface).

Lembre-se de que os usuários muitas vezes não pensam nos problemas que estão encontrando exatamente nos mesmos termos que você. Por exemplo, os usuários podem achar estranho pensar em si mesmos como uma "conta". Certifique-se de projetar sua funcionalidade de pesquisa e indexação, em seguida, para levar em conta prováveis variações terminológicas e sinônimos.

Entre a interface do usuário principal e o sistema de Ajuda, no entanto, os termos devem ser muito semelhantes, se não idênticos. Os usuários podem ficar confusos quando o idioma do sistema de Ajuda não se correlaciona muito com o que eles estão vendo na tela.

Writing compelling Help link text

Ao vincular a um tópico da Ajuda a partir da interface do usuário principal, certifique-se de escrever um texto atraente do link da Ajuda. Uma linguagem clara e específica inspira confiança. Os usuários tendem a acreditar que links de Ajuda genéricos (um botão com a palavra "Ajuda" ou "Saiba mais") não levarão à informação certa sem um investimento significativo de tempo.

Se você fizer apenas cinco coisas...

1. Projete sua interface do usuário para que os usuários não precisem de Ajuda.
2. Torne sua Ajuda útil concentrando o conteúdo nas principais perguntas nos principais cenários para seus usuários-alvo.
3. Apresente o conteúdo da Ajuda para que seja fácil de escanear.
4. Entenda que você não precisa fornecer ajuda para todos os recursos da interface do usuário.
5. Torne os pontos de entrada da Ajuda detetáveis e atraentes.

Padrões de utilização

Diferentes tipos de conteúdo servem diferentes propósitos.

Tipo de conteúdo	Exemplo
Ajuda Processual fornece as etapas para a execução de uma tarefa.	A ajuda processual deve concentrar-se na informação sobre "como", em vez de "o quê" ou "porquê". Neste exemplo, o tópico da Ajuda descreve como usar um recurso do utilitário Limpeza de Disco, fornecendo etapas a serem seguidas em sequência.
Conceptual Help fornece informações básicas, visões gerais de recursos ou processos.	A ajuda conceitual deve fornecer informações sobre "o quê" ou "por quê" além das necessárias para concluir uma tarefa. Neste exemplo, o tópico da Ajuda define o que é a área de trabalho e fornece detalhes adicionais sobre o que ela contém e por que os usuários interagem com ela.
Reference Help serve como um livro de referência online.	Você pode usar a ajuda de referência para documentar uma linguagem de programação ou interfaces de programação. Neste exemplo, o tópico da Ajuda lista as convenções tipográficas em uso para esse idioma ou aplicativo específico, fornecendo as informações em uma tabela fácil de verificar.

Orientações

Pontos de entrada

• Link para tópicos de Ajuda específicos e relevantes. Não crie um link para a home page da Ajuda, o sumário, uma lista de resultados de pesquisa ou uma página que apenas vincule a outras páginas. Evite criar links para páginas estruturadas como uma grande lista de perguntas frequentes, pois isso força os usuários a procurar aquela que corresponde ao link em que clicaram. Não crie links para tópicos específicos da Ajuda que não sejam relevantes e úteis para a tarefa em questão. Nunca crie links para páginas vazias.

• Não coloque links de Ajuda em todas as janelas ou páginas por uma questão de consistência. Fornecer um link de Ajuda em um só lugar não significa que você tenha que fornecê-los em todos os lugares.

• Utilize links de ajuda para caixas de diálogo, mensagens de erro, assistentes e painéis de propriedades. Se o link de ajuda se aplicar a controlos específicos, coloque-o por baixo deles, alinhado à esquerda. Se o link Ajuda se aplicar a toda a janela, coloque-o no canto inferior esquerdo da área de conteúdo da janela.

  

  Neste exemplo, o segundo link da Ajuda se aplica a um grupo de controles.

  

  Neste exemplo, o link Ajuda se aplica a toda a janela.

• Use links de Ajuda em vez de referências textuais genéricas para Ajuda sempre que for tecnicamente possível.

  Correto:

  Como posso reparar erros de disco?

  Incorreto:

  Para obter mais informações sobre como reparar erros de disco, consulte Ajuda e suporte.

• Use a Help button with the Help icon for the hub pages of control panel items. Coloque-o no canto superior direito. Esses botões não têm um rótulo, mas têm uma dica de ferramenta que diz 'Ajuda'.

  

  Um item do painel de controle com um botão Ajuda.

• F1 Help is optional. Os usuários se acostumaram a encontrar informações de Ajuda relacionadas ao contexto imediato da interface do usuário na tela pressionando a tecla F1, que é rotulada como Ajuda em teclados padrão. Você pode incluir a Ajuda F1 se, por exemplo, estudos de usabilidade mostrarem que seus usuários esperam encontrá-la ou se a interface do usuário do programa for complexa o suficiente para se beneficiar de assistência contextual.

• Os programas com barras de menus podem ter uma categoria de menu Ajuda. Para obter diretrizes do menu Ajuda, consulte Menus.

  

  Neste exemplo, o acessório do Windows Paint tem uma categoria do menu Ajuda.

• Para acessibilidade do teclado, forneça paradas de tabulação para botões e links de Ajuda.

• O comportamento do botão Ajuda e do link deve ser o seguinte: O painel Ajuda é aberto e um tópico dedicado da Ajuda é exibido; a interface do usuário que invocou o painel Ajuda deve permanecer aberta para preservar a experiência contextual.

• Não use os seguintes estilos obsoletos de ponto de entrada da Ajuda: "Saiba mais" ou "Saiba mais sobre..." links, botões de Ajuda genéricos e botões de Ajuda sensíveis ao contexto na barra de título. Embora tenham sido usados no passado, estudos de usabilidade determinaram que os usuários tendem a ignorá-los. Em vez disso, use links para tópicos específicos da Ajuda. Para obter diretrizes sobre como escrever bons Links de Ajuda, consulte Links de Ajuda.

  Incorreto:

  

  Não use "Saiba mais" ou "Saiba mais sobre..." ligações.

  Incorreto:

  

  Não use botões genéricos de Ajuda.

  Incorreto:

  

  Não use botões de Ajuda sensíveis ao contexto na barra de título.

Conteúdo

• Não crie conteúdo óbvio. Os tópicos da Ajuda que repetem o que está na interface do usuário principal não agregam valor.
• Não crie conteúdo sobre o qual o usuário não possa agir de alguma forma.
  • Exceção: Alguns conteúdos conceptuais fornecem informações de fundo importantes sem levarem necessariamente à ação do utilizador.
• Evite resoluções vagas para problemas. Por exemplo, "entre em contato com o administrador do sistema" ou "reinstale o aplicativo" tendem a frustrar os usuários.
  • Exceção: Recomendo entrar em contato com o administrador do sistema, se essa for a única solução prática, e os administradores do sistema esperam ser contatados para o problema.
• Evite conteúdo que aborde cenários de usuário altamente improváveis. Desenvolva o seu conteúdo de Ajuda principal para o que você prevê que será o uso normal; Observe exceções importantes ao uso esperado, mas trate esse conteúdo como uma prioridade menor.
• Reúna feedback dos seus utilizadores sobre a utilidade dos tópicos da Ajuda. Permitir que os usuários classifiquem tópicos individuais. Conduct usability studies on your documentation to ascertain problems involving quality and discoverability of content.
  • Dica: O feedback dos usuários também é uma ótima maneira de gerar mais conteúdo baseado em tarefas, focado no que os usuários estão realmente fazendo com seu programa, em vez de conteúdo baseado em recursos, focado simplesmente em uma descrição da tecnologia.
• Forneça várias formas de aceder ao seu conteúdo. A table of contents, an index, and a search mechanism are three of the most common methods of improving discoverability.
• Se houver mais de uma maneira de executar uma tarefa, na maioria dos casos você pode apenas documentar a maneira mais comum usada por usuários inexperientes.

Ícones

• Utilize o ícone de Ajuda somente para janelas do Explorer e páginas centrais de itens do painel de controlo. Não use o ícone Ajuda com links de Ajuda.

Correto:

Neste exemplo, uma janela do Windows Explorer usa um ícone da Ajuda para fornecer acesso à Ajuda.

Incorreto:

Neste exemplo, o ícone Ajuda no canto inferior esquerdo é usado incorretamente com um link de Ajuda.

Texto

Links de Ajuda

• Forneça informações específicas sobre o conteúdo do tópico da Ajuda, usando o máximo de texto relevante e conciso necessário. Os utilizadores muitas vezes ignoram links de Ajuda genéricos. Certifique-se de que os resultados do link são previsíveis: os usuários não devem se surpreender com os resultados.

  • Exceção: Você pode usar "Mais informações" para complementar instruções que estão diretamente na interface do usuário, especialmente se fornecer informações específicas no link Ajuda levar a repetições desnecessárias ou tornar o link menos atraente.

  Incorreto:

  Uma palavra-passe forte tem pelo menos seis letras maiúsculas, números e símbolos mistos. O que é uma palavra-passe forte?

  Correto:

  Uma palavra-passe forte tem pelo menos seis letras maiúsculas, números e símbolos mistos. Mais informações

  No exemplo incorreto, o link Ajuda é repetitivo. Ele faz uma pergunta que realmente já está respondida.

• Sempre que possível, escreva o texto do link da Ajuda em termos da pergunta principal respondida pelo conteúdo da Ajuda. Não use o fraseado "Saiba mais sobre", "Diga-me mais sobre" ou "Obtenha ajuda com isso".

  Incorreto:

  Saiba mais sobre como adicionar exceções

  Correto:

  Quais são os riscos de permitir exceções?

  Como adiciono exceções?

  Nos exemplos corretos, o link é formulado em termos da pergunta principal respondida pelo tópico da Ajuda.

• Se as informações mais relevantes puderem ser resumidas de forma sucinta, coloque o resumo diretamente na interface do usuário em vez de usar um link de Ajuda. No entanto, você pode usar um link de Ajuda para fornecer informações suplementares.

  Incorreto:

  

  Correto:

  

  Better:

  

  O exemplo correto resume as informações da Ajuda de forma sucinta, melhorando consideravelmente a probabilidade de os usuários as lerem. O melhor exemplo fornece um link de Ajuda para obter mais informações sobre este assunto complexo.

• Phrase Help links to clearly indicate assistance. Os links de ajuda nunca devem ser lidos como links de ação.

• Utilize o link completo de Ajuda para o texto do link, não apenas as palavras-chave.

  Correto:

  Quais são os riscos de permitir exceções?

  Incorreto:

  Quais são os riscos de permitir exceções?

  In the correct example, the entire Help link sentence is used for the link text.

  • Exception: Help links to external Web sites should simply use the name of the site or page as the link. Qualquer texto que introduza o nome do site não precisa ser incluído no link em si.

• Os links de Ajuda não precisam corresponder exatamente aos títulos dos tópicos da Ajuda, mas deve haver uma conexão forte e óbvia entre os dois. Crie links e cabeçalhos em pares por esse motivo.

  Correto:

  Como posso melhorar o desempenho desta funcionalidade? (link text)

  Configurando esse recurso para um desempenho ideal (título do tópico)

  Incorreto:

  Como posso melhorar o desempenho desta funcionalidade? (link text)

  Visão geral completa deste recurso (título do tópico)

  No exemplo incorreto, o título do tópico da Ajuda difere substancialmente em escopo do texto do link da Ajuda e pode ser desorientador.

• Se o conteúdo da Ajuda estiver online, deixe isso claro no texto do link. Isso ajuda a tornar o resultado dos links previsível.

  Correto:

  Para obter formatos e ferramentas adicionais, vá para o site da Microsoft.

  Incorreto:

  Onde posso encontrar formatos e ferramentas adicionais?

• Use frases completas.

• Não use pontuação final, exceto para pontos de interrogação.

• Don't use ellipses for Help links or commands.

Conteúdo de Ajuda

• Formate os elementos da interface do usuário usando negrito para facilitar a identificação. This is especially useful for procedural Help topics, allowing users to scan through procedures and quickly see pertinent UI elements.
• Formate legendas usando itálico. Isso se aplica a tabelas, arte, capturas de tela e outros elementos gráficos que se beneficiam de uma breve explicação textual.
• Refer to Help simply as Help. Geralmente, não use a frase Ajuda on-line, a menos que você esteja de fato se referindo ao conteúdo do seu site.