Was sind einige Ressourcen für das Lernen Spezifikationen zu schreiben?

StackOverflow https://stackoverflow.com/questions/112969

  •  02-07-2019
  •  | 
  •  

Frage

Bei der Arbeit bin ich verantwortlich für Spezifikationen recht oft schreiben, und ich bin auch die Person, die auf immer Spezifikationen in erster Linie darauf bestanden. Das Problem ist, ich bin nicht sicher, wie Spezifikationen aussehen sollte und was sie enthalten. Ein großer Teil der Zeit, als mein Chef Schreiben der Spezifikationen (wir beide unerfahren darin sind) setzen sie in Tabellennamen und Dinge, die ich glaube nicht, gehören dort. Also, was ist ein guter Weg, um eine gute spec schreiben zu lernen?

EDIT: Sollte eine funktionale Spezifikation gehören Dinge wie vorausgesetzt, ich eine Web-Anwendung am Angabe, die Eingangstypen (ein Textfeld, Dropdown-Liste, etc.)

?
War es hilfreich?

Lösung

Der wichtigste Teil der Entwicklungsdokumentation meiner Meinung nach, ist die richtige Person, die es tun.

  • Anforderungen Docs - User + Business Analyst
  • Functional Spec - Business Analyst + Entwickler
  • Technische Spec (wie die Funktionalität tatsächlich umgesetzt werden) - Sr. Entwickler / Architekt
  • Zeit-Schätzungen für Disponierzwecke - Die spezifischen Entwickler , um die Aufgabe zugewiesen

Mit jemand neben der Sr. Entwickler / Architekt definieren Tabellenstrukturen / Schnittstellen usw. ist eine Übung in Vergeblichkeit -. Als erfahrener Entwickler im Allgemeinen die meisten davon aus werfen

Wikipedia ist eigentlich ein guter Anfang für die Functional Spec, die auf Ihre Spec ähnlich scheint - http: / /en.wikipedia.org/wiki/Functional_specification .

Andere Tipps

Es gibt ein großes Kapitel in Steve McConnell Code Complete , die durch Spezifikation läuft Dokumente und was sie enthalten.

Als ich beauftragt wurde, eine Architektur und Business Analysis Team bei einem Unternehmen zu bauen, die auch nie gehabt hatte, benutzte ich McConnell spec Kapitel den Entwurf für die technische Spezifikation Dokument zu erstellen. Es entwickelte sich im Laufe der Zeit, aber mit diesem Rahmen ausgehend stellte ich sicher, wir haben nichts vermisst und es stellte sich heraus, überraschend brauchbar sein.

Wenn Spezifikationen schreiben, eine Faustregel ich folgen, um zu versuchen technische Dokumente haben immer von den allgemeinen beginnen und auf den spezifischen zu bewegen - immer das Geschäft Problem umformulieren (n) oder Ziel (n), dass die technische Lösung ist entwickelt zu lösen, so dass die Person, die die Spezifikation lesen muss nicht auf andere Dokumente gehen, um es in jeder Art von Kontext stellen.

Siehe Painless Functional Specs von Joel Spolsky.

Einige der Dinge, die er sagt, sollte jede spec haben:

  • Ein Disclaimer
  • Ein Autor. Ein Autor
  • Szenarien
  • Nongoals
  • Ein Überblick
  • Details, Details, Details
  • Offene Probleme
  • Side Notizen

Das Wichtigste ist, nicht als etwas abgewertet werden Sorgen über das Format.

Kaufen Bücher: Requirements Engineering von Ian Sommerville & Pete Sawyer ISBN 0-471-97444-7 oder Software-Anforderungen von Karl Wiegers ISBN 0-7356-0631-5

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top