Melhor software para escrever manuais de usuário baseados em HTML [fechados

Question

Estou trabalhando em um projeto em que preciso gerar documentação do usuário final para um software. Em algum momento do próximo ano, o software que estou escrevendo esta documentação será aposentado. Portanto, não desejo gastar muito tempo em um manual de nível profissional. Isso é algo que os estudantes de pós -graduação em uma faculdade e alguns profissionais da casa estarão vendo. Embora se for bom e útil o suficiente, eu possa alimentá -lo de volta à comunidade OpenSource como documentação gratuita.

Eu estava pensando que um manual HTML seria um bom ajuste. O software está escrito no PHP, então quem estiver usando ele terá um navegador da Web aberto e pronto para ir. Isso também leva à possibilidade de mim ou de outra pessoa, integrando as páginas do manual ao próprio software.

Não estou interessado em fazer/usar um wiki para este software. O que realmente estou procurando é um software em que posso escrever como um documento normal e gerar HTML simples. Sei que existem peças de software como Dreamweaver e FrontPage, mas eu estava particularmente interessado em algo projetado para facilitar o processo de criação de documentação (onde o processo de levar capacas de tela e vídeos é integrado junto com a simples edição de imagem/vídeo).

Se você acha que outra abordagem (que não seja HTML Docs) pode ser melhor, eu adoraria ouvi -la. Se você tem outra abordagem e acha que conhece uma boa solução de software para conseguir isso, me avise.

Meus principais desejos para a abordagem e o software para alcançá -lo são

• Simplicidade na implantação (as páginas HTML não requerem configuração especial. Um diretório de ajuda pode simplesmente ser implantado com todas as páginas manuais)
• Nenhum software especial necessário para utilizar (o HTML pode ser lido por todos que têm um navegador da Web)
• Facilidade de uso para eu escrever a documentação / pequena curva de aprendizado (não quero gastar muito tempo aprendendo um software complicado para trabalhar em um projeto relativamente pequeno)
• Capacidade de combinar texto, vídeos e imagens em documentos únicos (as páginas HTML obviamente suportam a exibição de todas elas juntas)

Obrigado!

@Lie ryan: "Mediawiki armazena todo o texto e dados (páginas de conteúdo, detalhes do usuário, mensagens do sistema etc.) em um banco de dados ..." que é o que eu quero evitar. Eu acho que os wikis são ótimos e úteis, mas estou interessado em fornecer dados estáticos com uma sobrecarga muito baixa.

Answer 1

Sempre que sou obrigado a escrever manuais do usuário (o que significa que toda vez que terminar um projeto), gosto de usar Markdown. Combinado com CSS mínimo, é muito fácil de usar.

O Markdown é uma ferramenta de conversão de texto para HTML para escritores da Web. O Markdown permite que você escreva usando um formato de texto simples fácil de ler e fácil de escrever e converta-o em XHTML (ou HTML) válido estruturalmente válido.

Assim, “Markdown” são duas coisas: (1) uma sintaxe de formatação de texto simples; e (2) uma ferramenta de software, escrita em Perl, que converte a formatação de texto simples em HTML.

Answer 2

Eu acho que isso não atende exatamente a todos os seus requisitos, mas sou um grande fã de Esfinge. Você escreve sua documentação em Descanso, e você pode gerar versões HTML e PDF com bastante facilidade. A geração HTML usa modelos, por isso é bastante personalizável. Além disso, há o benefício adicional de ter as versões de texto simples ao redor (o descanso é um tanto legível como está) para aqueles de nós que gostam dessas coisas :)

Answer 3

Escreva o manual em XML, use algo como DocBook. Isso permitirá que você faça o que precisar com o conteúdo e, em seguida, gerar a apresentação à sua maneira.

Há muito tutoriais no DocBook to HTML Tools por aí.

Edit: esqueci de mencionar que OO pode salvar no docbook.

Answer 4

Eu sugeriria apenas escrever no OpenOffice e publicar no PDF. O PDF, talvez ainda mais que o HTML, é agnóstico da plataforma e parece quase idêntico em vários clientes e sistemas operacionais. Se você realmente deseja vídeo, pode vincular a um site externo, como o YouTube ou o que você tem do PDF.