¿Qué herramienta/formato usas para escribir tus especificaciones?

Question

Me gustaría saber qué tipo de herramienta utiliza para escribir sus especificaciones. Creo que es esencial usar una herramienta que soporte algún tipo de formato de texto sin formato para que uno pueda controlar la especificación con un sistema de control de fuente como SVN. Para la especificación en cuanto al código también, es importante tener un historial de todos los cambios.

Actualmente escribimos nuestras especificaciones en un formato XML. TeX también sería una alternativa, pero es difícil para las personas que nunca han trabajado con ella.

Así que avíseme qué tipo de herramientas o formatos utiliza para las especificaciones.

Answer 1

DocBook editado con XXE, traducido al pdf con xslt cuando sea necesario para ser enviado a los clientes.

El mejor cambio de la historia, mucho más fácil de escribir, mucho más fácil de combinar, y cuando se convierte no se ve tan descuidadamente profesional como MSWord.

Además, el estilo de documento estructurado ya está allí, a diferencia de la palabra sangrienta que tiene que luchar para ponerse a trabajar.

Answer 2

He venido a usar Docbook para todo eso. Es fácil, flexible y generará html, tex (y por lo tanto pdf), etc.

Answer 3

Utilizamos tex (MikTeX) y fue perfecto porque:

• queja de texto - edición en Vim/Bloc de notas - en todos los sitios
• potente formato usando macros predefinidas uno de nosotros hizo
• generación onclick a PDF

El único problema era conseguir diagramas (de ArgoUML) en.

En otro proyecto vi utilizar plantillas de Word: cosas horribles dirigidas desde arriba.

Consideraría usar algo como wiki/forum en la intranet. Imagina usar GoogleDocs: hay versiones, está en línea ... pero no es aplicable para el desarrollo comercial.

Answer 4

Microsoft Word. Sé que no cumple con sus requisitos, pero en cada trabajo que he tenido he usado Microsoft Word para las especificaciones. Puede, y tengo, poner documentos de Word en un sistema de control de fuente: lo único que pierde es la capacidad de diferenciar entre documentos. Aunque recuerdo vagamente haber leído en alguna parte que hay herramientas de diff para Word que pueden usarse.

Answer 5

En el trabajo, muchos de nuestros documentos pasan por Sharepoint u otro sistema de documentos que realmente ralentiza la "publicación" de un documento. Esto significa que hay copias de los documentos en todo el lugar y conseguir que alguien libere adecuadamente algo es un dolor de cabeza. Debido a esto, normalmente recibí las especificaciones en power point o papel de desecho. Así que puse en funcionamiento una wiki (Media Wiki) en la que ahora guardamos todas las especificaciones del proyecto. Esto les permite ser visibles para cualquier persona de la empresa y editable por nuestro grupo de desarrollo. A veces, un desarrollador le pedirá al jefe una aclaración a medida que pasan o lo que sea y el desarrollador puede actualizar las especificaciones, lo que creo que es una gran ventaja. Además, cuando las personas actualizan una especificación con nueva información usando la historia, es muy fácil ver cuáles fueron los cambios más recientes, lo que significa que puedo ver lo que estaba sucediendo antes y lo que debe suceder ahora, lo que creo que es una gran ventaja.

Todavía conservo una especificación que estaba garabateada en un papel de cuaderno en mi pared como recordatorio.

Answer 6

En el trabajo utilizamos una wiki porque son geniales para la colaboración, pero Microsoft Word funcionará.

En realidad, puede diferenciar dos versiones diferentes de un documento de Word utilizando Word en sí: utiliza la función "cambios de pista" para mostrar las diferencias. (Si no me crees, prueba a distinguir dos versiones de un documento de Word usando TortoiseSVN.)

Para documentos largos, prefiero Word en la wiki porque es muy adecuado para editar documentos largos y la gente de negocios es más trabajo cómodo con documentos de Word.