Herramienta para fines de documentación de software.

Soy desarrollador de software y estoy buscando una herramienta para escribir documentación de software en colaboración con mi equipo.
Esto significa que esta herramienta debe tener algún mecanismo de control de versiones para lograr la posibilidad de escribir diferentes capítulos por parte de diferentes miembros del equipo
. Con "documentación de software" me refiero a algo así como un manual, no una documentación técnica.

El último requisito es que esta herramienta sea de código abierto.

¿Alguien puede sugerirme alguna herramienta útil para este propósito?

Gracias por adelantado.

¿Solo enviar mensajes de texto con quizás algunos gráficos conectados, o algo más sofisticado? ownCloud/Nextcloud se envía con un editor compatible con LibreOffice que permite la edición colaborativa, ¿sería suficiente (hay algunas demostraciones disponibles que podría probar)? Si no, hay una variante más avanzada de LibreOffice que se puede usar por separado o también integrada en ownCloud/Nextcloud. Las dos *nubes tenían la ventaja de ofrecerle calendario/contactos, así como "almacenamiento de archivos" que podía usar con el equipo.
¿Estás seguro de que realmente quieres decir código abierto ? ¿Planeas cambiar el código y agregar nuevas funciones? Si simplemente no desea pagar, agregue la etiqueta gratis . Y agregue una etiqueta para el sistema operativo.
¿Hay alguna razón por la que el editor de texto para editar texto + git para el control de versiones no sea suficiente?
Aunque doxygen está destinado principalmente a la documentación técnica, también se puede utilizar para otra documentación (por ejemplo, el manual de doxygen se genera por medio de doxygen). Así que definitivamente vale la pena echarle un vistazo.

Respuestas (1)

Recomiendo encarecidamente echar un vistazo a la cadena de herramientas del generador de documentos Sphinx .

La creación del documento se realiza como un conjunto de archivos ReStructuredText (con la posible inclusión de algunos otros formatos como Markdown), que son completamente compatibles con los sistemas de control de versiones como git, svn, mercurial, etc. Las plantillas se pueden usar para dar un estilo coherente con el documento final publicado.

El documento final se puede generar en múltiples formatos y algunos sitios como ReadTheDocs generarán automáticamente sus documentos en respuesta a nuevas confirmaciones y lanzamientos (ver aquí ) para su repositorio o el de sus equipos en sitios como GitHub, Bitbucket o GitLab.

  • Gratis, gratis y de código abierto
  • Multiplataforma (Escrito en Python)
  • Los archivos de entrada son totalmente compatibles con el control de versiones
  • Formatos de salida: HTML (incluida la Ayuda HTML de Windows), LaTeX (para versiones PDF imprimibles), ePub, Texinfo, páginas de manual, texto sin formato
  • Amplias referencias cruzadas: marcado semántico y enlaces automáticos para funciones, clases, citas, términos del glosario y piezas de información similares
  • Estructura jerárquica: fácil definición de un árbol de documentos, con enlaces automáticos a hermanos, padres e hijos
  • Índices automáticos: índice general así como índices de módulos específicos del idioma
  • Manejo de código: resaltado automático usando el resaltador Pygments que maneja la mayoría (>300) lenguajes de programación.
  • Múltiples temas atractivos disponibles como temas integrados (alrededor de 8), descargas desde lugares como PyPi , GitHub y sphinx-themes.org o escribiendo los suyos propios .
Herramienta para fines de documentación de software.
RespuestasAquíPolítica de privacidad1y, 2v