Projetando um Sistema de Ajuda

Question

Estou implementando um sistema de ajuda para um aplicativo de desktop (Win32) e procuro saber como desenvolvê-lo.

Que tipo de estrutura um sistema de ajuda deve ter, o que é realmente útil para o usuário? por exemplo.O sistema de ajuda deve ser uma grande lista de perguntas frequentes (a ajuda do office 2010 parece ser assim)?ou deveria ser uma lista de recursos documentando e descrevendo o que tudo faz (isso provavelmente só será útil se o usuário não tiver certeza de como funciona um recurso que já conhece)

Que tipo de conhecimento devo esperar que o usuário final tenha?Provavelmente é um pouco humilhante escrever no arquivo de ajuda que File -> Open Project Fecha o projeto atual (se presente) e abre um projeto existente.

O que procuro aqui é alguma orientação, um conjunto de recursos que qualquer bom sistema de ajuda deve ter e um método de organizar os tópicos de forma que os usuários possam encontrá-los.

Answer 1

"Projeto aberto" também pode ser um bom lugar para colocar uma referência à definição de um projeto e outras descrições e procedimentos mais gerais relacionados à abertura de projetos.

Em geral, a ajuda do CHM é acessada através da ajuda sensível ao contexto (que é o típico para o caso de arquivo-> aberto) e através do índice geral, pesquisa de texto completo e índices. Os aplicativos mais recentes parecem criar apenas uma página de ajuda por contêiner (um diálogo ou menu pullodwn), onde eles listam todos os itens na tela (por exemplo, por captura de tela anotada) e não um lema para cada item (caixa de seleção, entrada de menu) em a GUI. Menos confusão e navegação, e muitos pontos precisam apenas de uma breve descrição

Além da ajuda sensível ao contexto, também é possível navegar na ajuda por meio do sistema de ajuda.

Um CHM é muito parecido com um e-book, com um sumário (TOC), índice e opcionalmente suporte para pesquisa de texto completo.

A pesquisa de índice e de texto completo são maneiras de o usuário pesquisar conteúdo. A principal diferença é que o índice está mais sob seu controle e a pesquisa de texto completo é amplamente automática quando ativada.

O TOC é uma visualização em árvore de nós que agem como o TOC em um livro e deve fixar a estrutura geral do "ebook". As perguntas frequentes são normalmente um apêndice neste sumário.

Além disso, existe uma página de "entrada" padrão, que é como a página inicial de um site. Ele deve levar os usuários aos tópicos mais pesquisados.

Tenha cuidado ao comparar os produtos da Microsoft. Às vezes, eles usam sistemas que ainda não estão disponíveis para usuários finais / desenvolvedores.

Boa ajuda usa todos esses elementos.

Answer 2

Existem basicamente dois estilos de ajuda: baseado em referência (ou seja, o que esta caixa de seleção significa?) e baseado em tarefas (como faço para obter XYZ?).

Provavelmente, é melhor criar primeiro um tutorial baseado em tarefas, com o respaldo de um FAQ, se necessário.