Diretrizes de ajuda do aplicativo

Applies to Windows and Windows Phone

Estas diretrizes descrevem como projetar conteúdo da ajuda eficaz para seu aplicativo. O conteúdo da ajuda deve estar em uma única página e pode incluir texto, links e imagens. Se você precisar fornecer conteúdo dinâmico de ajuda, vincule a um site de suporte ou incorpore uma página online em sua seção de ajuda.

Meu aplicativo deve incluir conteúdo de ajuda?

Inclua uma seção de ajuda apenas se o seu aplicativo precisar. Por exemplo, se houver apenas um ou dois elementos de interface do usuário em seu aplicativo que podem ser confusos para os usuários, tente integrar interface do usuário instrucional, criar uma demonstração simples no aplicativo ou reprojetar esses elementos para evitar a criação de uma página de ajuda que só aborde algumas questões. No entanto, se o seu aplicativo for mais complexo, adicionar um conteúdo útil de ajuda pode realmente beneficiar os usuários.

O que fazer e o que não fazer

  • Use um submenu Configurações para exibir o conteúdo da ajuda. Quando você usa um submenu Configurações, pode adicionar facilmente Ajuda ao painel Configurações fornecido pelo Windows.
  • Permita que os usuários acessem a Ajuda a partir do painel Configurações.
  • Rotule o ponto de entrada no painel Configurações como "Ajuda" para identificá-lo claramente. Consulte Guidelines for app settings para obter mais recomendações.
  • Mantenha a página Ajuda curta e de fácil leitura para os usuários.
  • Se o conteúdo da Ajuda não couber em uma só página, ou se você precisar incluir conteúdo dinâmico que precisará atualizar, vincule a um site de suporte ou incorpore uma página online no seu submenu Ajuda. Lembre-se de que a vinculação de uma página da Web tira seu usuário da experiência do aplicativo. Se possível, incorpore o conteúdo online para criar uma experiência de usuário mais coesa. Se você estiver escrevendo um aplicativo em JavaScript, consulte How to include online content in your help para obter uma orientação passo a passo.
  • Não vincule diretamente a um site a partir do ponto de entrada da Ajuda no painel Configurações. Em vez disso, forneça um link para conteúdo online no submenu Ajuda associado.
  • Não use jargões e termos técnicos.
  • Não use a Ajuda para documentar cada recurso em seu aplicativo. A Ajuda deve ser um lugar para uma consulta rápida e básica. Se você desejar fornecer conteúdo detalhado sobre seu aplicativo, considere fornecer um link para uma página da Web de suporte no final de seu conteúdo de Ajuda.
  • Não use a Ajuda para notificar os clientes de que há uma nova versão do aplicativo disponível. As informações de versão são fornecidas por padrão na seção Permissões do painel Configurações.

Tópicos relacionados

Para designers
Diretrizes para criar uma interface do usuário instrucional
Guidelines for app settings
Para desenvolvedores (aplicativos do Tempo de Execução do Windows em JavaScript e HTML)
WinJS.UI.SettingsFlyout object
Adicionando a ajuda do aplicativo
Interface do usuário de aplicativo da Windows Store (HTML)
Para desenvolvedores (aplicativos do Tempo de Execução do Windows em C#/VB/C++ e XAML)
Windows.UI.XAML.Controls.SettingsFlyout
Adicionando a ajuda do aplicativo (aplicativos da Windows Store em C#/VB/C++ e XAML)
Interface do usuário de aplicativo da Windows Store, do início ao fim (XAML)

 

 

Mostrar:
© 2014 Microsoft