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?

Se incluir Ajuda ou não, depende exclusivamente de você. Lembre-se de que nem todo aplicativo necessita de uma seção de Ajuda. Por exemplo, se seu aplicativo contém somente um ou dois elementos de interface do usuário que pode confundir o usuário, você pode integrar a interface do usuário com instrução, criar uma demonstração simples no aplicativo ou considerar reformular esses elementos em vez de criar uma seção de ajuda separada.

O que fazer e o que não fazer

  • Mantenha as páginas de Ajuda curtas 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 da Windows Store em JavaScript, consulte How to include online content in your help para obter diretrizes passo a passo.
  • Não use jargões e termos técnicos.
  • Não use a Ajuda para documentar todos os recursos de seu aplicativo. 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.
  • Applies to Windows

    • Permita que os usuários acessem a Ajuda a partir do painel Configurações.
    • 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.
    • Rotule o ponto de entrada no painel Configurações como "Ajuda" para identificá-lo claramente. Para obter mais recomendações de configurações, veja Guidelines for app settings.
    • 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.

Tópicos relacionados

Para designers
Diretrizes para criar uma interface do usuário instrucional
Guidelines for app settings
Para desenvolvedores (HTML)
WinJS.UI.SettingsFlyout object
Adicionando a ajuda do aplicativo
Interface do usuário de aplicativo da Windows Store (HTML)
Para desenvolvedores (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