CODEWITHSUNDEEP
specifications
dso
dso

Reputation: 9580

What Makes a Great Functional Specification Great?

What qualities made it so great, and what made it stand out compared to the not-so-great specs that you've had to deal with? Or, if you've never worked with a good functional spec before, what sort of things would you expect in a great spec?

Sorry this is obviously subjective but I'm creating a functional spec (not my first) and it just occurred to me that I may get some good ideas from the bright folks on SO!

Upvotes: 18

Views: 6591

Answers (4)

Ali
Ali

Reputation: 267307

The Project Aardvark specs from Joel on Software are the best I've come across so far. Each screen is defined very well, with pictures. The main features of the software are described, as well as some technical details.

Sadly the specs I've received personally aren't that brilliant. Usually they are just a bulleted list of features they expect from each section of the system, and they expect you to work out all the details. Which is fine, I guess. However, I'm writing a game design document for an RPG game I'm working on as a personal project, and I think the specs I'm writing are very well written. I've divided the game into Sections such as

  • Characters
  • Weapons & Armor
  • Levels
  • Map
  • Physics

and so on, and described each section in terms of gameplay as well as some technical details. Its very easy to work through.

I also highly recommend reading the Painless Functional Specs Series from Joel on Software for anyone interested in writing better specs.

Upvotes: 11

Morph
Morph

Reputation: 1719

A good spec should state what the application is supposed to do, in a clear manner.

This seems obvious, but the stuff I usually get is often very vague. Apparently it's not very easy for people to express what they want on paper, IF they even know what they want.

Upvotes: 2

William Leara
William Leara

Reputation: 10697

IMHO, a key quality should be that the functional spec specifies the "what" in great detail but not the "how". That way, the requestor (marketing?) gets the look & feel and feature set that they want, but the implementation is left to those who know it best -- the developers.

Upvotes: 4

Erich Kitzmueller
Erich Kitzmueller

Reputation: 36987

Obviously, the specification should be complete, consistent and comprehensible. IMO it should also be well-organized, in that it keeps all requirements for a specific part of the product together. I've more than once read specifications where requirements for some module were scattered throughout the whole document, e.g. the general description is in chapter 4, but additional requirements can found in clauses in chapters 2, 5, 7 and appendix B. To work with such a specification, I first have to create a cross-reference map of requirements to modules.

Upvotes: 3

Related Questions