Software Requirements Documentation
Home > Ask the Software Quality Experts > Software Requirements Questions & Answers > How to structure a software requirements document
Ask The Software Quality Expert: Questions & Answers
EMAIL THIS

How to structure a software requirements document

Karl E. Wiegers EXPERT RESPONSE FROM: Karl E. Wiegers

Pose a Question
Other Software Quality Categories
Meet all Software Quality Experts
Become an Expert for this site


Software quality news and advice
Digg This!    StumbleUpon Toolbar StumbleUpon    Bookmark with Delicious Del.icio.us    Add to Google


>
QUESTION POSED ON: 19 September 2007
I have recently been tasked to write a requirements document, although I have an understanding of the structure of the document, I would like an example document or case study of an already written requirements document. I am quite fuzzy on the language to use within this document and how clearly to get the points across to the designer. Any assistance would be greatly appreciated. Thanks.

>
EXPERT RESPONSE

It's certainly true that people learn better from examples than just from descriptions or templates. It's hard to find good public examples, though, because most organizations view their requirements documents as proprietary.

You can access a sample integrated set of requirements documents here. These are drawn from Appendix D of my book, Software Requirements, 2nd Edition. There is a vision and scope document, several use case descriptions, and a software requirements specification (SRS), all for a hypothetical project called the Cafeteria Ordering System. The SRS does not contain all of the requirements for the system, but enough so you can see good examples of how to write them. These documents also illustrate the data dictionary, some simple business rules, and some analysis models (context diagram, entity-relationship diagram, state-transition diagram). These examples should give you a good idea of how you might complete each section in the templates available here.

Software requirements documentation:
Software Requirements, Second Edition -- Chapter 7, Hearing the Voice of the Customer

Software requirements specification template

Tuning up your software requirements reviews

I recommend that every organization build a collection of process assets that includes sample documents drawn from actual projects. These can serve as useful aids for anyone who needs to create similar documents on a future project. As your teams develop better examples with experience or as you undertake different kinds of projects, you can update the contents of the process assets collection. Your process assets collection also should include appropriate document templates, procedure and process descriptions, checklists, and other work aids. These items can save team members time by learning from past work that has been done in the organization.

Several other sample requirement specifications from actual projects are available at the following URLs. They reflect different templates, different writing styles, different types of projects, and also different degrees of quality:


Sound Off! -   Be the first to post a message to Sound Off!


Digg This!    StumbleUpon Toolbar StumbleUpon    Bookmark with Delicious Del.icio.us    Add to Google


RELATED CONTENT
Software Requirements
Requirements engineering in an uncooperative environment
Scrum and requirements gathering
Requirements reporting beyond use cases
Requirements gathering with storyboards
How to elicit performance requirements
Developing use cases that support business goals
Requirements discipline throughout the SDLC
The difference between gap analysis and requirements analysis
Software requirements elicitation and documentation
Requirements gathering for payroll application

Software Requirements Documentation
Requirements reporting beyond use cases
Test cases from requirements specifications and use cases
Software requirements sign-off essential for solid QA
Requirements discipline throughout the SDLC
Testability requirements and verification work
Poor business requirements process leads to high project costs, study finds
Software requirements elicitation and documentation
Requirements gathering for payroll application
Testers' involvement in requirements gathering important
Requirements gathering, SRS and use cases

RELATED GLOSSARY TERMS
Terms from Whatis.com − the technology online dictionary
functional specification  (SearchSoftwareQuality.com)
requirements analysis  (SearchSoftwareQuality.com)
Software Engineering Institute (SEI)  (SearchSoftwareQuality.com)
software requirements specification  (SearchSoftwareQuality.com)
Wirth's Law  (SearchSoftwareQuality.com)

RELATED RESOURCES
2020software.com, trial software downloads for accounting software, ERP software, CRM software and business software systems
Search Bitpipe.com for the latest white papers and business webcasts
Whatis.com, the online computer dictionary



Search and Browse the Expert Answer Center
Search and browse more than 25,000 question and answer pairs from more than 250 TechTarget industry experts.
Browse our Expert Advice

About Us  |  Contact Us  |  For Advertisers  |  For Business Partners  |  Site Index  |  RSS
SEARCH 
TechTarget provides enterprise IT professionals with the information they need to perform their jobs - from developing strategy, to making cost-effective IT purchase decisions and managing their organizations' IT projects - with its network of technology-specific Web sites, events and magazines.

TechTarget Corporate Web Site  |  Media Kits  |  Reprints  |  Site Map




All Rights Reserved, Copyright 2006 - 2008, TechTarget | Read our Privacy Policy
  TechTarget - The IT Media ROI Experts