Atualmente, usamos um sistema chamado AsciiDoc que permite criar documentação em uma simples marcação de texto. A partir disso, podemos gerar vários formatos de saída. Utilizamos apenas os formatos de saída pdf e chm.
Eu queria saber se havia uma alternativa para chm? O que estou procurando é algo que possa ser usado off-line (isso é importante porque muitos de nossos usuários estão em lugares muito remotos) com o nosso software. Ele deve ter um índice (pode ser tão simples quanto uma página html com termos com hiperlink), deve ser pesquisável e deve ter um mecanismo que permita que entradas específicas sejam chamadas a partir do código (semelhante à ajuda sensível ao contexto).
As duas coisas que são contra o PDF nesse caso são:
- A ajuda sensível ao contexto não é uma opção
- Geralmente o documento é bastante grande
- PDF é mais adequado para documentação impressa do que ajuda sensível ao contexto
O que eu gostaria é usar html. O único problema com o html é que não consigo descobrir como fornecer automaticamente uma pesquisa por palavra-chave (além da funcionalidade ctrl + f do navegador - eu gostaria de algo mais aparente). Também não consigo encontrar um método para gerar automaticamente um índice com hiperlink de palavras-chave. A ajuda sensível ao contexto seria simples por causa das tags de seção - eu poderia simplesmente passar o URL da página e da seção que me interessam no navegador padrão e essa página deve carregar na seção correta.
Meus requisitos parecem muito com chm - eles parecem. Eu modelei meus requisitos fora do chm. A única razão pela qual eu não gosto do chm é por causa da maneira como o código interage com ele usando mapids e tal. Eu preferiria usar armazenar uma lista de texto sem formatação (que é gerada automaticamente para mim) que meu código pode usar para acessar a parte sensível ao contexto da documentação.
Estou imaginando um script que percorra os arquivos de saída html e gere uma página de índice que simplesmente contenha uma lista de palavras-chave encontradas. obviamente, deve haver um mecanismo de exclusão de palavras para ignorar palavras como: the, it, is, etc. Esta parte seria relativamente fácil de escrever. A segunda parte precisaria de um script de algum tipo para reunir um banco de dados de palavras-chave e sua localização no texto html. Eu acho que essa seria a parte mais complicada, além de fornecer o mecanismo de pesquisa no navegador.
Qualquer idéia sobre alternativas seria apreciada. Eu adoraria usar um wiki ou um conjunto de páginas html estáticas hospedadas em um servidor da Web em algum lugar, mas temos um requisito crítico de uso offline. Simplesmente colocar o html na unidade local não nos fornece os requisitos de pesquisa necessários.
EDITAR:
Eu desenho software que é usado pela indústria de mineração. Muitas minas são muito remotas e não têm acesso significativo à Internet. Não há nada de errado com pdf, html ou chm (exceto que ele está ficando velho). Se eu pudesse exibir um arquivo pdf no local correto (por exemplo, ajuda sensível ao contexto), eu o usaria. Estou quase tentado a escrever o meu próprio - basicamente, seria um wiki portátil. Por falar nisso, se você sugere um wiki portátil - você deve pensar no usuário final que pode não ter experiência em usar essas ferramentas. Tem que ser muito simples. Essa foi a beleza do chm, é uma dor trabalhar com eles, mas com os usuários finais.