CMS o Wiki para documentación de software y guías de usuario, posible duplicación fuera de línea

Actualmente estoy buscando en el mercado una documentación de software y una solución de guía de usuario para nuestra organización.

Somos una tienda de software .Net de tamaño mediano que actualmente enviamos archivos .chm compilados con nuestros lanzamientos, un proceso que consideramos un tanto anticuado y no nos brinda la posibilidad de un diseño adecuado. Dado que queremos utilizar esta documentación como un manual del usuario, necesitamos opciones de plantillas modernas y soporte de medios. Se supone que la creación de la documentación debe pasar de los desarrolladores a los gerentes de productos y, por lo tanto, debe ser fácil de usar para los que no son programadores. Planeamos distribuir un espejo sin conexión que funcione de esta documentación con lanzamientos, por lo tanto, la opción de distribución sin conexión es vital. La opción de alojar también esta documentación en línea y que se pueda navegar por completo sería una gran ventaja. Nos asustan un poco los agujeros de seguridad, por lo que la calidad del código y la política de actualización son una gran preocupación para nosotros. Los costos de licencia son posibles, si la solución de pago ofrece más ventajas. Los despliegues comerciales (posiblemente con modificaciones) son obligatorios.

Hasta ahora he visto bastantes wikis y CMS, pero estoy algo perdido en cuanto a qué software sería una solución mantenible para nuestros requisitos específicos. También siento que nuestros requisitos no deberían ser lo suficientemente extravagantes como para que nadie ofrezca soluciones especializadas para este tema.

Agradezco cualquier ayuda que me puedan brindar.

Respuestas (1)

Le sugiero que utilice un software diseñado específicamente para la documentación. He usado varios de ellos, todos gratuitos y de código abierto. Cada uno es ligeramente diferente, pero todos son bastante buenos, así que los miraría todos y luego elegiría el que más me gusta.

Aquí hay una lista de los que he usado (o considerado usar) yo mismo. Cada uno tiene sus fortalezas y debilidades, por lo que no recomendaré una sola opción:

  • Sphinx es un programa de Python que crea sitios HTML de documentación (y archivos PDF) a partir de documentos reStructuredText.
  • ReadTheDocs es una aplicación web construida sobre Sphinx, con algunas funciones de gestión de proyectos. Si no desea usar Sphinx directamente, puede usar el sitio web de RTD o ejecutar su propia copia en su propio servidor.
  • MkDocs es similar a Sphinx y produce una documentación muy atractiva. Dicho esto, es mucho más nuevo y todavía tiene algunos errores que corregir.
  • Slate es uno de los programas más nuevos y está diseñado con un enfoque en la documentación técnica de la API. Dicho esto, hay empresas que también lo están utilizando para sus guías de usuario. Hay una lista de guías de ejemplo en la parte inferior de la página que incluye algunos ejemplos que no son de API.

Hay algunos más que he visto, pero que no he usado, así que no puedo opinar sobre ellos. Sin embargo, los incluyo para completar. Usted puede encontrar uno de ellos para ser un mejor ajuste.