Quale strumento/formato si usa per scrivere le specifiche?[chiuso]

Question

Vorrei sapere che tipo di strumento che si utilizza per scrivere le vostre specifiche.Penso che sia indispensabile l'utilizzo di uno strumento che supporta un qualche tipo di formato di testo normale, in modo che si può controllare specifica, con un sistema di controllo come SVN.Per la specifica come per il codice, è importante avere una cronologia di tutte le modifiche.

Oggi scriviamo la nostra specifica in un formato XML.TeX sarebbe anche un'alternativa, ma è difficile per le persone che non hanno mai lavorato con lui.

Fatemi sapere, che tipo di strumenti o formati utilizzare per specifiche.

Answer 1

DocBook modificato con XXE, tradotto in pdf con xslt, quando necessario, da inviare ai clienti.

Meglio cambiare mai, in modo molto più facile scrivere, in modo molto più semplice per unire, e quando si è trasformato non ha un aspetto così godawfully poco professionale come MSWord.

Più strutturato stile del documento è già lì, a differenza di bloody parola che si deve lottare per ottenere il lavoro.

Answer 2

Abbiamo usato TeX (MikTeX) ed è stato perfetto perché:

• querela di modifica del testo in Vim/blocco note - ovunque
• potenti funzioni di formattazione utilizzando macro predefinite uno di noi ha fatto
• onclick generazione di PDF

L'unico problema è stato quello di ottenere diagrammi (da ArgoUML) in.

In un altro progetto ho visto che utilizza modelli di Word - roba brutta diretto dall'alto.

Mi piacerebbe prendere in considerazione di utilizzare qualcosa come wiki/forum sulla rete intranet.Immagino con GoogleDocs - c'è il controllo delle versioni, è online..ma non è applicabile per lo sviluppo commerciale.

Answer 3

Al lavoro un sacco di documenti in Sharepoint o di un altro documento di sistema che in realtà rallenta il "rilascio" di un documento.Questo significa che ci sono le copie dei documenti in tutto il luogo e qualcuno liberare correttamente qualcosa è un mal di testa.A causa di questo io di solito ricevuto specifiche in power point o pezzi di carta.Così ho messo su un wiki (Media Wiki), che ora tenere tutte le specifiche di progetto in.Questo permette loro di essere visualizzabili da chiunque in azienda e modificabile dal nostro gruppo di sviluppo.A volte uno sviluppatore a chiedere al boss per un chiarimento su come passare da o qualsiasi altra cosa e lo sviluppatore può aggiornare la spec stessi che credo sia un enorme vantaggio.Inoltre, quando le persone di aggiornamento spec con nuove informazioni utilizzando la storia è molto facile vedere ciò che le modifiche più recenti sono stati - significato che posso vedere cosa è successo prima e quello che deve succedere ora, che credo sia un enorme vantaggio.

Ho ancora una spec che è stato scarabocchiato su alcuni notebook di carta sulla mia bacheca come un promemoria.

Answer 4

Ho imparato ad usare Docbook per tutte queste cose.È facile, flessibile, e generare il codice html, tex (e quindi pdf), etc.

Answer 5

Microsoft Word.So che non soddisfa le tue esigenze, ma in ogni lavoro che ho avuto ho usato Microsoft Word per le specifiche.È possibile, e ho messo i documenti di Word in un sistema di controllo di origine - L'unica cosa che si perde è la capacità di diff tra i documenti.Sebbene io vagamente ricordo di aver letto da qualche parte che ci sono diff strumenti per la parola, che possono essere utilizzati.

Answer 6

Al lavoro usiamo un wiki, perché sono ottimi per la collaborazione, ma Microsoft Word di lavoro.

Si può effettivamente diff due diverse versioni di un documento di Word utilizzando la Parola stessa - si utilizza la funzionalità di "revisioni" per mostrare le differenze.(Se non mi credete, provate a diffing due versioni di un documento di Word utilizzando TortoiseSVN.)

Per i documenti lunghi, io in realtà preferisco Parola sulla wiki perché è anche adatto per l'editing di documenti lunghi e la gente di affari sono più a suo agio a lavorare con i documenti di Word.