Me gustaría entregar una herramienta de TI para usar en Windows. Se trata de un filtro ISAPI y quiero describir la instalación, las operaciones y la configuración.
Actualmente esto se hace en un archivo de texto, que es bastante completo, pero creo que no es muy utilizable. Creo que tengo un buen manejoquédebería estar en la documentación. Me gustaría recibir información sobre elCómoparte. ¿Cuál es la mejor manera de entregar documentación a los administradores de servidores web de Windows?
.CHM? .PDF? .DOCX? .HTM?
EDITAR: IteníaEra un archivo de texto, pero se estaba volviendo muy largo y tenía posibilidades limitadas de vinculación, referencias cruzadas, indexación y organización. Veamos, una sección principal se subraya con signos iguales, una subsección se subraya con guiones... etc, etc. Así que intenté formatearlo de esta manera pero al final el archivo .txt simplemente no se escaló.
Actualizar: Seleccioné SHFB. Aquí esta lasalida de ayuda HTML. ¿Qué opinas? ¿usable?
Respuesta1
Aquí está mi opinión:
- El texto ASCII es fantástico: puedo leerlo en cualquier lugar
- HTML es el segundo mejor; también puedo leerlo prácticamente en cualquier lugar.
- El PDF es aceptable pero algo molesto ya que es posible que necesite consultarlo en un servidor sin un lector de PDF instalado.
- CHM es una molestia debido al estúpido control de ayuda HTML (¡gracias a los errores/vulnerabilidades del control de ayuda HTML!), y no es un formato muy amigable para cortar/pegar
- DOCX es simplemente molesto: no tengo "Office" instalado en mis servidores y si necesito consultar la documentación allí, estoy seguro de que no la cargaré.
Respuesta2
Tengo que utilizar archivos de texto ASCII con el formato adecuado. Se pueden leer desde el portátil, el servidor, windows, unix, linux, etc.
No debería tener que depender de un navegador web, Adobe Reader, Office o cualquier otro programa para leer cómo instalar algo en mi servidor. Debe ser sencillo e indoloro.
La verdad es que... en caso de apuro... incluso podría leer el archivo de texto desde mi teléfono celular si fuera necesario.
Estoy seguro de que cualquiera que haya estado atrapado en una instalación de colo a las 3 de la mañana en circunstancias poco deseables (es decir, llamado desde el bar, sin computadora portátil, etc.) estaría de acuerdo. ;-)
Sólo mis 2 centavos...
Respuesta3
deberías revisarasciidoc. Hice algunas cosas breves con él y el resultado es bastante nítido (y personalizable, por supuesto). El texto sin formato es muy legible por diseño y puede generar documentos en formato docbook, HTML y PDF fácilmente. Utilizando cualquier cantidad de otros convertidores, también puedes transformarlo a otros formatos, como CHM.
Sin embargo, es un paquete muy versátil, al ser un paquete centrado en UNIX, no sé cómo es el soporte de Windows.
Respuesta4
Sé que ya aceptaste una respuesta, pero pensé en recomendarla.esfinge. Escribe el documento en reStructuredText pero puede generar fácilmente html que se pueda buscar (pequeño javascript). /