Criando helpfile em HTML

Question

Eu estou enfrentando a tarefa divertida de criar um ficheiro de ajuda para um grande projeto. Tenho descartado arquivos CHM devido aos constrangimentos e agora estão olhando para arquivos baseados em HTML, mas ainda estou indeciso sobre o formato ....

Existem 3 áreas estou focando em:

reutilização de seções (muitas páginas pode se referir a um texto) Uma vez que algumas seções serão usadas mais de uma vez na helpfile, eu preciso criar uma seção principal e, em seguida, ligar para as seções mestre em cada subseção. Este então eu evitar ter que alterar a legenda vários lugares ao fazer edições.

Searchfunctionality Eu gostaria de ser capaz de pesquisar texto livre no arquivo.

Printability. O usuário pode selecionar para imprimir seções ou documento wholde.

Eu estava primeira inclinando-se para a abordagem wiki ter plugins para exportar o wiki em páginas estáticas para distribuição, mas eu não encontrei essa solução ...

Todas as sugestões de vocês nesta matéria? Estou fazendo helpfiles ao complicado?

Agradecemos antecipadamente!

Answer 1

Reutilização

Eu vejo duas abordagens. Você pode criar páginas individuais para as seções que deseja reutilizar, e depois simplesmente ligar para eles sempre que necessário. Esta é trivial em HTML.

Você pode, alternativamente, criar um trecho ou fragmento de HTML com as informações para essa seção, e depois usar server-side includes (ou uma tecnologia similar) para incluí-lo em linha onde quer que seja necessário. Desta forma, o conteúdo aparecerá ter sido escrito em cada página individual, mas quando você precisa fazer uma edição ainda é apenas em um lugar.

Pesquisar

Se o site é público, deixar que o Google indexá-lo, e apenas oferecer uma caixa de pesquisa Google. Você não é provável para obter melhores resultados do que isso.

Printability

A "folha de estilo de impressão" em CSS é fácil de montar e pode eliminar todos os elementos gráficos que tornam o site atraente na web, preservando todo o conteúdo para uso em papel.

Imprimir o documento inteiro de uma só vez exigiria algum pequeno pedaço de programação para combinar todo o conteúdo em uma única página com a finalidade de imprimir. Pessoalmente, eu prefiro a oferta ainda que o serviço, para desencorajar as pessoas a desperdiçar papel.

É claro, nós podemos oferecer todos os tipos de insights sobre como alcançar nenhuma dessas coisas, mas desde que parece que você está depois conselhos gerais, no momento, isso é meu.

Answer 2

Eu acredito wikis são perfeitos para documentação, especialmente quando mais de uma pessoa é (ou será) envolvidos no projeto. De ligação entre páginas wiki ou namespaces é facilmente alcançada. Mudar o nome de uma página vai mudar todos os hiperlinks em outros documentos. Gostaria de evitar a duplicação de conteúdo, sempre que possível, porém, se é isso que você estava sugerindo.

Eu uso DokuWiki que suporta página de exportação. Você pode despejar todo o seu wiki em texto simples, XHTML ou órgão XHTML (para colocar dentro do seu próprio modelo, ou para anexar a um único arquivo para impressão, etc).

Espero que ajude!