Gostaria de fornecer uma ferramenta de TI para uso no Windows. A questão é um filtro ISAPI e quero descrever a instalação, operações e configuração.
Atualmente isso é feito em um arquivo de texto, que é bastante completo, mas acho que não é muito utilizável. Acho que tenho um bom controleo quedeve estar na documentação. Gostaria de sugestões sobreComopapel. Qual é a melhor maneira de fornecer documentação para administradores de servidores web Windows?
.CHM? .PDF? .DOCX? .HTM?
EDITAR: EUtiveera um arquivo de texto, mas estava ficando muito longo e tinha recursos limitados para vinculação, referência cruzada, indexação e organização. Vejamos, uma seção principal é sublinhada com sinais de igual, uma subseção é sublinhada com travessões... etc etc. Então tentei formatar desta forma, mas no final o arquivo .txt simplesmente não foi dimensionado.
Atualizar: Selecionei SHFB. Aqui está osaída de ajuda HTML. O que você acha? utilizável?
Responder1
Aqui está minha opinião:
- O texto ASCII é ótimo - posso ler isso em qualquer lugar
- HTML é o segundo melhor - também posso ler isso em qualquer lugar
- PDF é aceitável, mas um tanto irritante, pois posso precisar consultá-lo em um servidor sem leitor de PDF instalado
- CHM é uma dor por causa do estúpido controle de ajuda HTML (obrigado, HTML Help controla bugs/vulnerabilidades!), e não é um formato muito amigável para recortar/colar
- DOCX é simplesmente irritante - não tenho o "Office" instalado em meus servidores e se precisar consultar a documentação lá, tenho certeza de que não irei carregá-lo
Responder2
Preciso usar arquivos de texto ASCII formatados corretamente. Eles podem ser lidos no laptop, servidor, Windows, Unix, Linux, etc.
Eu não deveria depender de um navegador da web, Adobe Reader, Office ou qualquer outro programa para ler como instalar algo em meu servidor. Deve ser simples e indolor.
A verdade é que... em apuros... eu poderia até ler o arquivo de texto do meu celular se fosse necessário.
Tenho certeza de que qualquer pessoa que tenha ficado presa em uma instalação de colo às 3 da manhã em circunstâncias nada desejáveis (ou seja, bipado no bar, sem laptop, etc.) concordaria. ;-)
Apenas meus 2 centavos...
Responder3
Você deveria conferirasciidoc. Eu fiz algumas coisas curtas com ele, e o resultado ficou bem nítido (e personalizável, é claro). O texto simples é muito legível por design e você pode gerar documentos, HTML e PDF facilmente. Usando vários outros conversores, você também pode transformá-lo em outros formatos, como CHM.
Pacote muito versátil, porém, sendo um pacote centrado em UNIX, não sei como é o suporte do Windows.
Responder4
Eu sei que você já aceitou uma resposta, mas pensei em recomendaresfinge. Você escreve o documento em reStructuredText, mas pode facilmente gerar html pesquisável (minúsculo javascript). /