Páginas de ajuda externaExternal help pages

Se seu aplicativo exigir ajuda detalhada para conteúdo complexo, considere hospedar estas instruções em uma página da Web.If your app requires detailed help for complex content, consider hosting these instructions on a web page.

Quando usar páginas de ajuda externaWhen to use external help pages

As páginas de ajuda externa são menos convenientes para uso geral ou referência rápida.External help pages are less convenient for general use or quick reference. Elas são adequadas para conteúdo da ajuda que é muito extenso para ser incorporado ao próprio aplicativo, bem como para tutoriais e instruções de funções avançadas de um aplicativo que não serão usados pelo público em geral.They are suitable for help content that is too extensive to be incorporated into the app itself, as well as for tutorials and instructions for advanced functions of an app that won't be used by its general audience.

Se o conteúdo da ajuda for breve ou suficientemente específico, você deve exibi-lo no aplicativo.If your help content is brief or specific enough to be displayed in-app, you should do so. Não direcione os usuários para fora do aplicativo para obter ajuda, a menos que isso seja necessário.Do not direct users outside of the app for help unless it is necessary.

Quando um usuário é direcionado para uma página de ajuda externa, siga um destes dois cenários:When a user is directed to an external help page, follow one of two scenarios:

  • Eles são vinculados diretamente à página que corresponde a um problema conhecido.They are linked directly to the page that corresponds with their known issue. Isso é ajuda contextual e deve ser usada quando possível.This is contextual help, and should be used when possible.
  • Eles são vinculados para uma página de ajuda geral, com uma exibição clara de categorias e subcategorias a serem escolhidas.They are linked to a general help page, with a clear display of categories and subcategories to choose from.

Fornecer aos usuários uma maneira de pesquisar sua ajuda pode ser útil, mas não torne essa pesquisa a única maneira de navegar por sua ajuda.Providing users with a way to search your help can be useful, but do not make this search the only way of navigating your help. Algumas vezes, pode ser difícil para os usuários descreverem seus problemas, o que pode dificultar a pesquisa.It can sometimes be difficult for users to describe their problems, which can make searching difficult. Os usuários devem ser capazes de encontrar rapidamente as páginas relevantes para seus problemas sem necessidade de pesquisar.Users should be able to quickly find pages relevant to their problems without needing to search.

Tutoriais e guias passo a passo detalhadosTutorials and detailed walkthroughs

As páginas de ajuda externa são o local ideal para fornecer aos usuários tutoriais e guias passo a passo, sejam textuais ou em vídeo.External help pages are the ideal place to provide users with tutorials and walkthroughs, whether video or textual.

  • Os tutoriais devem focalizar ideias mais complicadas e funções avançadas.Tutorials should focus on more complicated ideas and advanced functions. Os usuários não devem precisar de um tutorial para usar seu aplicativo.Users shouldn't need a tutorial to use your app.
  • Exiba esses tutoriais de forma diferente das instruções da ajuda padrão.Make sure that these tutorials are displayed differently from standard help instructions. Os usuários que estão procurando instruções avançadas são mais ávidos para pesquisar por elas que os usuários que desejam soluções simples para os problemas.Users who are looking for advanced instructions are more eager to search for them than users who want straightforward solutions to their problems.
  • Considere fornecer links para tutoriais de um diretório e de páginas de ajuda individuais que correspondam a cada tutorial.Consider linking to tutorials from both a directory and from individual help pages that correspond to each tutorial.