Herramienta tipo wiki para escribir especificaciones y documentación [cerrado]


9

Estoy buscando un wiki o un sistema similar al wiki para escribir y administrar especificaciones y documentación para un proyecto de software.

Sé que hay muchas implementaciones de wiki disponibles, pero ¿hay algunas que sean especialmente adecuadas para este tipo de tarea?

En realidad, no tiene que ser una wiki, solo un sistema que facilita la escritura y navegación de especificaciones y documentación, y que admite el seguimiento de cambios.


1
¿Estás usando una plataforma especial? ¿Como el TFS de Microsoft, por ejemplo?
Saeed Neamati

En línea con lo que @Saeed preguntó, ¿qué tipo de infraestructura tiene su equipo / organización ya implementado para la gestión y el intercambio de conocimientos? Además, ¿cuáles son sus procesos actuales para escribir especificaciones y documentos?
Thomas Owens

Respuestas:


6

Estamos usando LaTeX y SVN. Dado que los documentos LaTeX son solo archivos de texto, funciona bien con el control de versiones, a diferencia de algunos formatos binarios o parcialmente binarios.

Obtiene todas las ventajas (y desventajas, sin duda) del control de versiones al que está acostumbrado de usarlo con su código.

LaTeX requiere un poco de configuración (para definir sus propios estilos / clase), pero una vez que lo haya hecho, es muy bueno: puede concentrarse únicamente en el contenido en lugar de su presentación (en lugar de sentirse tentado a modificar constantemente como lo hace con WYSIWYG), pero aún así obtengo un documento PDF elegante y de aspecto profesional al final.


4

Personalmente, me gusta mucho Tiddly Wiki .

Tiene una sintaxis wiki bastante completa, es un archivo html único autónomo y funciona bien con una variedad de navegadores web sin la necesidad de un servidor.

Incluso tiene una arquitectura de complementos extensible que le permite agregar complementos para hacer todo tipo de cosas interesantes como cifrar tiddlers o agregar notas al pie.


3

Para la plataforma Microsoft, la integración de TFS (Team Foundation Server) con SharePoint es justo lo que está buscando. Al crear un nuevo proyecto de equipo, puede elegir una plantilla que abarque casi todos los aspectos del proceso de desarrollo de software. Le proporciona un portal en el que puede definir los miembros del equipo, asignar sus roles y permisos de seguridad, cargar, compartir y editar documentos y especificaciones relacionadas con su proyecto, y hacer muchas otras cosas interesantes con él.

Para otras plataformas, creo que puedes usar algo como GitHub (aunque no estoy seguro de eso).


0

Para el proyecto personal (existente solo en mi PC), uso Wiki en un Jar . En el pasado trabajé con Redmine (además tiene un sistema de seguimiento de errores y SCM)


0

Puede probar Sphinx , con los documentos registrados en la infraestructura de administración de control de origen de su elección. Esto tiene las ventajas del control de código fuente y un lenguaje de marcado relativamente liviano, reStructuredText , que es fácil de aprender y está bastante bien instrumentado para las conversiones (a HTML, a PDF, etc.).

Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.