Como construir e entregar documentação para TI ferramentas no Windows? [fechadas]

Question

Como devo construir e entregar documentação para uma ferramenta de TI no Windows? Há uma restrição adicional que eu não quero gastar dinheiro em ferramentas de ajuda de autoria.

Aqui no SO, falamos de algoritmos e otimizações, APIs e desempenho. Mas um dos resultados dos meus esforços dev é documentação. Qual é a melhor maneira de construí-lo, e de que forma devo entregá-lo?

Se eu estou entregando um conjunto de .NET APIs, um CHM é um mecanismo razoável para a entrega. É muito fácil de usar SHFB para construir o arquivo de ajuda como parte da compilação, e se ele será usado principalmente no Windows, um CHM é muito acessível. E convertendo o CHM para .HTM torna o doc acessível, mesmo de forma mais ampla.

Mas eu quero entregar doc para um filtro ISAPI que não será usado por desenvolvedores por si, mas por administradores de servidores web Windows. Eu preciso para descrever a instalação, operação e configuração. Eu acho que os usuários finais podem muitas vezes têm desenvolvedor, bem como habilidades administrativas, mas em qualquer caso, para os meus propósitos a documentação cobrirá tarefas administrativas e questões operacionais.

Eu sei que SHFB me permite incluir arquivos HTML regulares no CHM. Se eu já sei SHFB, e se eu não quero gastar dinheiro em uma ferramenta de autoria de ajuda, esta é a melhor maneira de ir? Se não, o quê?

Answer 1

No final, eu decidi usar Sandcastle Help File Builder, a ferramenta gratuita disponível na http: //shfb.codeplex .com . Eu já utilizado castelo de areia para construir o doc de referência para um projeto diferente, então eu sabia algo sobre a ferramenta. Ela produz arquivos CHM ou .hxs, adequados para uso no Windows. Eu tive SHFB nunca usou a "design" um helpfule antes, mas foi muito fácil de entender como fazê-lo. Os resultados são muito bons.

Answer 2

Texlipse é um látex plugin para o Eclipse. Ambos são gratuitos. Em látex é usado por muitos pesquisadores para gerar seus documentos e ainda é usado por muitos livros de texto. É uma ferramenta gratuita que pode atender às suas necessidades.

Answer 3

Tente este asciidoc . Não é LaTeX, mas produz bom PDF / CHM / HTML e você pode ensinar a não-programador documentação escrita para você, que é um bônus agradável:)

Answer 4

Por que não escrever a documentação no escritório aberto e, em seguida, exportá-lo em pdf?

O látex é a forma profissional, mas não é rapidamente acessível.