Welches Tool / Format verwenden Sie für Ihre Spezifikationen zu schreiben? [geschlossen]

Question

Ich möchte wissen, welche Art von Werkzeug benutzen Sie für Ihre Spezifikationen zu schreiben. Ich denke, es ist wichtig, ein Werkzeug zu verwenden, das eine Art von Klartext-Format unterstützt, so dass man die Spezifikation mit einem Versionskontrollsystem wie SVN steuern kann. Für die Spezifikation wie für den Code als auch, ist es wichtig, eine Historie aller Änderungen zu haben.

Derzeit schreiben wir unsere Spezifikation in einem XML-Format. TeX wäre auch eine Alternative sein, aber es ist schwer für die Menschen, die noch nie mit ihm gearbeitet haben.

Lassen Sie mich wissen, welche Art von Werkzeugen oder Formate, die Sie für Spezifikationen verwendet werden.

Answer 1

DocBook mit XXE bearbeitet, übersetzt pdf mit Xslt wenn an Clients gesendet werden muß.

Beste Veränderung überhaupt, so viel einfacher zu schreiben, so viel einfacher zu verschmelzen, und wenn es umgesetzt ist es sieht nicht so godawfully unprofessionell wie MS Word.

Plus des strukturierte Dokumentstil ist schon da, im Gegensatz zu blutigem Wort, das Sie mit zu kämpfen haben, um zu arbeiten.

Answer 2

Wir benutzten TeX (MikTeX) und es war perfekt, denn:

• plaint Text - Bearbeiten in Vim / Notepad - einfach überall
• leistungsstarke Formatierung mit vordefinierten Makros von uns tat
• Onclick Generation PDF

Das einzige Problem war, Diagramme zu erhalten (von ArgoUML) in.

Bei einem anderen Projekt habe ich Word-Vorlagen verwenden -. Schreckliche Sachen von oben gerichtet

würde ich mit so etwas wie dem Wiki / Forum im Intranet betrachten. Stellen Sie sich vor Verwendung GoogleDocs -. Es ist Versionierung, es ist online .. aber nicht für die kommerzielle Entwicklung

Answer 3

Bei der Arbeit gehen viele unserer Dokumente unter Sharepoint oder einem anderen Dokument System, das wirklich die „Freigabe“ eines Dokuments verlangsamt. Das heißt, es sind Kopien der Dokumente überall und immer jemand richtig etwas zu lösen ist ein Kopfschmerz. Aus diesem Grunde ich normalerweise Spezifikationen in Power Point oder Schrottpapier erhalten. Also habe ich ein Wiki (Media-Wiki) bei der Arbeit, die wir jetzt in allen Projektdaten halten. Auf diese Weise können sie von niemandem in der Firma und bearbeitbare durch unsere Entwicklungsgruppe sichtbar sein. Manchmal ist ein Entwickler den Chef um eine Klarstellung bitten, wie sie vorbeigehen oder was auch immer, und der Entwickler kann die Spezifikation aktualisieren sich die meiner Meinung nach ein großer Vorteil ist. Auch wenn die Menschen eine spec mit neuen Informationen aktualisieren, um die Geschichte mit ist es sehr einfach zu sehen, was die letzten Änderungen wurden - was bedeutet, kann ich sehen, was geschah vor und was jetzt geschehen muss, was ich denke, ist ein großer Vorteil.

Ich halte nach wie vor eine Spezifikation, die auf einig Notebook-Papier auf meiner Wand als Erinnerung gekritzelt wurde.

Answer 4

Ich bin gekommen, Docbook für alle diese Dinge zu verwenden. Es ist einfach, flexibel und html, tex (und damit pdf), etc. erzeugen.

Answer 5

Microsoft Word. Ich weiß es nicht mit Ihren Anforderungen nicht erfüllt, aber in jedem Job, den ich je hatte ich Microsoft Word für die Spezifikationen verwendet habe. Sie können, und ich habe, setzen Sie Word-Dokumente in einem Quellcodeverwaltungssystem - Das einzige, was Sie verlieren, ist die Fähigkeit, zwischen Dokumenten diff. Obwohl ich erinnere mich vage irgendwo zu lesen, dass es diff Tools für Wort, das verwendet werden kann.

Answer 6

Bei der Arbeit verwenden wir ein Wiki, weil sie für die Zusammenarbeit groß ist, aber Microsoft Word arbeiten.

Sie können diff tatsächlich zwei verschiedene Versionen eines Word-Dokument mit Word selbst - es nutzt die „Änderungen verfolgen“ -Funktion, die Unterschiede zu zeigen. (Wenn Sie mir nicht glauben, versuchen diffing zwei Versionen eines Word-Dokuments mit TortoiseSVN.)

Für lange Dokumente, ziehe ich es eigentlich Wort über das Wiki, weil es gut geeignet ist, lange Dokumente und Business-Leute zu Bearbeitung bequemer sind die Arbeit mit Word-Dokumenten.