Que ferramenta / formato que você usa para escrever suas especificações? [fechadas]

Question

Gostaria de saber que tipo de ferramenta que você usa para escrever suas especificações. Eu acho que é imprescindível a utilização de uma ferramenta que suporta algum tipo de formato de texto simples para que se possa controlar a especificação com um sistema de controle de origem como SVN. Para a especificação quanto ao código, bem, é importante ter um histórico de todas as alterações.

No momento nós escrevemos nossa especificação em um formato XML. TeX também seria uma alternativa, mas é difícil para as pessoas que nunca foram trabalhar com ele.

Então, deixe-me saber, que tipo de ferramentas ou formatos que você usa para especificações.

Answer 1

DocBook editado com XXE traduzida em pdf com XSLT quando necessário para ser enviado aos clientes.

Melhor mudança nunca, muito mais fácil de escrever, muito mais fácil de merge, e quando ele é convertido ele não parece tão godawfully pouco profissional como MSWord.

Além disso, o estilo de documento estruturado já está lá, ao contrário maldita palavra que você tem que lutar com a começar a trabalhar.

Answer 2

Nós usamos TeX (MikTeX) e foi perfeito porque:

• texto plaint - edição no vim / Bloco de Notas - apenas em todos os lugares
• formatação poderosa usando predefinidos macros um de nós fez
• geração onclick para PDF

O único problema era conseguir diagramas (de ArgoUML) em.

Em outro projeto que eu vi usando modelos do Word -. Coisas terríveis dirigido de cima

eu consideraria usando algo como wiki / forum na intranet. Imagine usar GoogleDocs -. Não é versionamento, é online .. mas não se aplica para o desenvolvimento comercial

Answer 3

No trabalho um monte de nossos documentos ir sob Sharepoint ou algum outro sistema documento que realmente retarda o "release" de um documento. Isto significa que existem cópias dos documentos em todo o lugar e conseguir alguém para liberar corretamente alguma coisa é uma dor de cabeça. Devido a isso eu normalmente recebido especificações em power point ou papel de sucata. Então eu colocar um wiki (Media Wiki) no trabalho que agora manter todas as especificações do projeto. Isto lhes permite ser visto por qualquer pessoa na empresa e editável por nosso grupo de desenvolvimento. Às vezes, um desenvolvedor irá pedir ao patrão para um esclarecimento como eles passam ou o que quer eo desenvolvedor pode atualizar a especificação-se que eu acho que é uma enorme vantagem. Além disso, quando as pessoas atualizar uma especificação com novas informações usando a história é muito fácil de ver o que as mudanças mais recentes foram - ou seja, eu posso ver o que estava acontecendo antes e que precisa acontecer agora, que acho que é uma enorme vantagem.

Eu ainda manter uma especificação que foi rabiscado em algum papel notebook-se na minha parede como um lembrete.

Answer 4

Eu vim para usar Docbook para todas essas coisas. É fácil, flexível e irá gerar html, tex (e, portanto, pdf), etc.

Answer 5

Microsoft Word. Eu sei que não cumpre com as suas necessidades, mas em todos os tenho trabalho que eu tinha eu usei Microsoft Word para as especificações. Você pode, e eu tenho, colocar documentos do Word em um sistema de controle de origem - A única coisa que você perde é a capacidade de diff entre documentos. Embora eu vagamente lembro de ter lido em algum lugar que existem ferramentas diff para a palavra que podem ser usados.

Answer 6

No trabalho usamos um wiki porque eles são grandes para colaboração, mas Microsoft Word irá funcionar.

Você pode realmente diff duas versões diferentes de um documento do Word usando própria Palavra - ele usa o "Controlar alterações" recurso para mostrar as diferenças. (Se você não acredita em mim, tente diffing duas versões de um documento do Word usando o TortoiseSVN.)

Para documentos longos, eu realmente prefiro Palavra sobre o wiki porque é bem adequado para a edição de documentos longos e pessoas de negócios são de trabalho mais confortável com documentos do Word.