A direção futura da Ajuda Formatos de arquivo

Question

Parece que CHM arquivos de ajuda não são mais o formato de escolha arquivo de ajuda.

WinHelp
- obsoletos

HtmlHelp (CHM)
- não suportada no Vista por padrão
- não funciona bem em um compartilhamento de rede

Ajuda 2 (HXS)
- Eu compreendo que este é usado em VS2005 + para exibir ajuda

Web Based
- Pode ser difícil de gerir para várias versões

O formato de arquivo de ajuda que você usaria em um novo aplicativo (C #), que fornece várias versões do mesmo código base?

Nós gostaríamos de usar CHM ajuda no entanto, não parece ser a direção que a Microsoft quer que se mudar.

O HXS ninguém empregar para os seus arquivos de ajuda?

Feeback apreciado

---

Atualização com base em comentários lassevk;

Parece que HXS ajuda não se destina a ser usado para projetos de ajuda normais.

---

Answer 1

O que exatamente faz você pensar que não há nenhum espectador .chm padrão no Windows Vista? (Há certamente um no meu computador, bem como na minha caixa de Win7)

Você pode confundir .chm com hlp (Microsoft de fato abandonou o suporte hlp em vista, então, eventualmente, retomou-o em um windows update)

A linha inferior: ficheiros.chm parecem ainda ser suportado em todas as versões do Windows, e a única alternativa real para arquivos .chm que eu conheço é .html

Answer 2

this.Mode = Modes.Rant;

Há enormes problemas com quase todos os formatos de arquivo de ajuda, porque os fabricantes (tipicamente Microsoft para muito poucos deles) não parecem querer fazer um trabalho mais do que apenas ligeiramente bom o suficiente para seu próprio uso.

Eu não posso te dizer quantas vezes o novo formato HXS foi metralhado completamente o meu Visual Studio ajuda quando 3 partes integrar. Você poderia dizer que isso é culpa dos terceiros ferramentas de instalação festa, mas por algum tempo não havia não documentação sobre como fazer isso, então eles tinham que escolher entre a engenharia reversa (e começá-lo errado , às vezes) ou não integrar a todos. Eu ainda não sei se a integração funciona, mas esses dias eu simplesmente mudar o Visual Studio para usar a ajuda online. Ele simplesmente funciona, principalmente, ao passo que o built-in ajuda invariavelmente cai para que a barra de progresso que apenas bloqueia Visual Studio até que reconstruiu o arquivo de ajuda, exceto que ele fez não porque os arquivos agora são corruptos, portanto, qualquer I hit tempo F1, Visual Studio apenas bloqueia a menos que eu matar o programa DExplore qualquer número de vezes.

Como isso acabou como uma solução para qualquer problema, eu ainda não sei.

Em segundo lugar, as ferramentas precisa estar presente. CHM telespectador está presente na pré-vista, não no Vista, mas as ferramentas necessárias para mostrar HXS não está presente no pré-vista, mas eu reunir eles estão no Vista. Bom, então agora eu tenho uma escolha entre usar um formato que precisa ser costume-instalado no computador do usuário, ou ... err, outro que precisa ser costume-instalado em outros computadores de usuários. Direita.

this.Mode = Modes.JustTicked;

Onde eu trabalho nós enviamos arquivos CHM, e uma versão html baseado em arquivo para aqueles que implantar suas aplicações através de um compartilhamento de rede. Quanto Vista, não temos visto muito disso ainda, mas a versão html iria trabalhar lá também.

Eu prefiro ter uma ajuda brilhante arquivo embora.

Um bom resultado de versão html é que podemos ligar nos mesmos arquivos no módulo web que segue o nosso produto. Desta forma, não seria apenas uma versão de que as necessidades dos clientes.

Nós estamos olhando para atualizar a ferramenta que usamos no trabalho assim na minha agenda para esta semana, agradável e tranquilo no trabalho, vou estar a olhar para os vários tipos de saída que pode produzir, entre outras coisas HXS.

---

Editar : Hmm, um rápido olhar para as páginas de ajuda para Ajuda e manual, o produto que usamos, tem este a dizer sobre HXS :

Visual Studio Ajuda também é conhecido como MS Ajuda 2.0. Originalmente este formato de ajuda foi concebido para ser o sucessor do HTML Help. No entanto, a Microsoft, em seguida, adiado seu lançamento indefinidamente e agora está claro que ele nunca vai ser lançado como um formato de ajuda para aplicações de usuários normais.

Por favor note que este é um formato de ajuda especial que é usado apenas para documentar os componentes de programação de terceiros projetados para integração em Visual Studio .NET. Não é adequado para qualquer outra finalidade e não pode ser usado para projetos de ajuda normais para programas de aplicação!

Eu acho que HXS é completamente fora da mesa depois.

---

Nota : Web-based não significa necessariamente que você precisa de um web servidor , só que você precisa de um web navegador . Se você integrá-lo em seu aplicativo, usando um componente de navegador web, ou se você apenas iniciar o navegador usuários padrão, que seria uma escolha que você teria que fazer, mas a maioria das saídas de Ajuda baseada na Web que eu vi não requer qualquer configuração do servidor em tudo.

Answer 3

Para mim, CHM ainda é a resposta. Eu construir arquivos CHM com o Sandcastle Help File Builder ferramenta que está disponível no Codeplex.

As preocupações sobre a acessibilidade de CHM são válidos. Para resolver isso, eu produzi um conversor CHM-to-Web muito facilmente, com alguma IStorage pirataria, um texto de pesquisa e substituição, e transformar um XSL. Esta página é um web site que foi produzido automaticamente em cerca de 8 segundos. Tem um treeview expandir / recolher no nav-mão-lado esquerdo. Frames base (não muito URL amigável) mas funciona bem o suficiente.

Answer 4

A única útil documentação de ajuda que eu já vi foi HTML simples. A maioria, se não todos, dos projetos de código aberto que eu vi todos têm HTML páginas de ajuda (por APIs e documentos de referência). Qualquer coisa que usa um formato proprietário ou que requer um leitor proprietária tudo correr o risco de ir obsoleto (CHM), ou ter compatibilidade ou problemas bloat (PDFs).

Por alguma razão, a Microsoft é apenas ruim em arquivos de ajuda. A ajuda online para o Visual Studio / SQL Estúdio / Escritório é terrível, MSDN é uma bagunça, CHMs são desajeitado, e procure a Microsoft nunca retorna os resultados que você realmente quer. (Apenas a minha opinião:)

Answer 5

conteúdo Adobe RoboHelp pode ser usado para autor conteúdo de ajuda que tem / index / search / glossário e obras em um navegador como é HTML gerado. Suporta 35 idiomas.

Nós temos uma aplicação web-based Flex que usa isso para gerenciar conteúdo de ajuda do aplicativo. O aplicativo Flex e seu trabalho sistema de ajuda na maioria dos navegadores em Windows / MacOSX / Linux.

Answer 6

Alguns pensamentos atualizados para qualquer um ainda está lendo esta pergunta ...

De acordo com a Wikipedia, a Microsoft decidiu sobre Microsoft Assistance Markup Language depois de desistir de um Ajuda 2 .

Há também Microsoft Sistema de Ajuda, que é o que vem com o Visual Studio 2010.