Vorlagen für technische und funktionale Spezifikationen [geschlossen]

Question

Grundsätzlich suche ich nach guten Vorlagen, um sowohl technische als auch funktionale Spezifikationen für ein Projekt oder eine Arbeitsanfrage zu verfassen.

Was benutzt du?Wie tief gehen Sie beim Schreiben der Spezifikationen vor?Für weitere allgemeine Tipps wären wir dankbar.

Mein Unternehmen braucht diese dringend.Ich arbeite für einen Auftragnehmer und im Moment verwenden wir diese Dokumente überhaupt nicht.

BEARBEITEN: Ich habe Joels Meinung darüber gelesen Schmerzfreie Spezifikation, es hat mir sehr gut gefallen, aber gibt es noch andere Meinungen :)

Answer 1

Zu allgemeinen Tipps;

Wir implementieren einen Prozess von

1) Geschäftsanforderungserklärung (BRS)

2) Funktionsspezifikation

3) Technische Spezifikation

Das BRS befasst sich mit den Geschäftsproblemen und den Anforderungen an Lösungen, Tests, Sicherheit, Zuverlässigkeit und Bereitstellung.Dies definiert, was eine erfolgreiche Lösung ausmachen würde.

In der Funktionsspezifikation wird detailliert beschrieben, was benötigt wird, wie es aussehen soll, wie lang Felder sein sollten usw.

In den technischen Spezifikationen wird detailliert beschrieben, woher die Daten stammen, sowie etwaiger kniffliger Code, der möglicherweise berücksichtigt werden muss.

Der Kunde besitzt die Anforderungen.Die technischen Spezifikationen liegen bei den Entwicklern, und die funktionalen Spezifikationen sind ein Mittelweg.Die Tests erfolgen anhand der technischen Spezifikationen (normalerweise Unit-Tests), dann anhand der Funktionsspezifikationen (normalerweise Systemtests) und dann anhand der Anforderungen (UAT).

Der wichtige Teil davon (und mit dem wir zu kämpfen haben) ist, dass die Entwickler weiterhin die Funktionsspezifikation und die ursprünglichen Geschäftsanforderungen erfüllen müssen.In Wirklichkeit dienen die funktionalen und technischen Daten lediglich der Verdeutlichung.

Kurz gesagt, mein wichtigster Tipp ist, zunächst den Prozess auszuarbeiten, den Sie implementieren möchten.Holen Sie dann die Zustimmung aller an Ihrem vorgeschlagenen Prozess beteiligten Parteien ein und arbeiten Sie dann an den passenden Vorlagen.Die Vorlagen selbst sind nur ein kleiner Teil der Änderung, die Sie vornehmen möchten.

Answer 2

Keine Vorlage, aber Joel hat eine geschrieben ein paar Artikel beim Schreiben einer funktionalen Spezifikation.Er hat auch Probe hier.

Answer 3

Sie können Vorlagen bei IEEE und anderen Anbietern kaufen, aber am Ende habe ich immer meine eigenen erstellt.

Für eine technische Spezifikation: „Code abgeschlossen„ von Steve McDonnell hat eine gute Checkliste, aus der man einige Informationen ziehen kann.Bei meinem letzten Job habe ich einfach eine Vorlage aus seinen Abschnittsüberschriften erstellt und sie von dort aus optimiert.

Was die Funktionsspezifikation betrifft, ist es wichtig, alle Schnittstellen zu definieren:

1. Benutzeroberfläche (Bildschirmmodelle)
2. Softwareschnittstellen (Plugins etc.)
3. Hardwareschnittstellen (falls zutreffend)
4. Kommunikationsschnittstellen (Dienste, E-Mail, Messaging usw.)

Es sollte auch einen Abschnitt für Geschäftsregeln geben, also Dinge, die funktional wichtig sind und in keiner Schnittstellendefinition abgedeckt sind.

Answer 4

Wenn Sie ein Buch kaufen möchten, Softwareanforderungen von Karl Wiegers enthält im Anhang Vorlagen für einige Dokumente.Leider bin ich auf der Arbeit und dieses spezielle Buch liegt zu Hause.Wenn jemand es zur Hand hat, kann er das vielleicht bestätigen.

Answer 5

Mir gefällt unter anderem dieses hier: FertigSet.

Er verkauft auch eine Pro-Version.

Answer 6

Das ist das Beste, was ich gefunden habe: http://www.jiludwig.com/templates/FRDTemplate.doc

Answer 7

Fangen Sie einfach an und arbeiten Sie sich von dort aus weiter.Da dies Ihre erste Erfahrung damit ist, verwenden Sie ein Word-Dokument mit Aufzählungspunkten.Schreiben Sie es, lesen Sie es noch einmal und geben Sie so viele Details an, dass es Sinn ergibt.Bei technischen Spezifikationen möchten Sie den Entwickler möglicherweise zu einer Lösung führen, bei funktionalen Spezifikationen sollte das „Wie“ jedoch völlig fehlen.

Answer 8

Ich würde vorschlagen, einen Blick auf die Volere-Vorlage von Roberston zu werfen Hier.Sie sind Teil der Atlantic Systems Guild, zusammen mit Leuten wie Tom DeMarco und Timothy Lister von „Peopleware“.

Da die Vorlage urheberrechtlich geschützt ist, werde ich sie hier nicht reproduzieren, Ihnen aber einige der wichtigsten Überschriften geben:

1. Der Zweck des Projekts
2. Die Stakeholder
3. Vorgeschriebene Einschränkungen
4. Namenskonventionen und Terminologie
5. Relevante Fakten und Annahmen
6. Der Umfang der Arbeit
7. Geschäftsdatenmodell und Datenwörterbuch
8. Der Umfang des Produkts
9. Funktionale Anforderungen
10. Schauen und fühlen Anforderungen ...

Es gibt noch viele weitere, aber dies sollte Ihnen eine Vorstellung geben.Der interessanteste Teil der Vorlage ist die Anforderungs-Shell, die funktionale Anforderungen auf einer Art Cue-Card auflistet.Auch hier urheberrechtlich geschützt, aber wirklich wertvoll.

Suchen Hier im Kapitel 9.