Home Up

Requirements Documentation

wpe1.jpg (4007 bytes)Assisting enterprises in learning, exploring, reengineering, and implementing component-based/object-oriented software solutions using best-in-class methods.

More About Requirements ] [ Requirements Documentation ] Data Models ]                                             

 

Requirements Documentation

Requirements documents appear in many different formats. All too often these documents are so voluminous, dense, and complex that the eyes glaze over and the architects, designers, and most of all, the engineers never turn page one. So, the key is to create documentation (and not necessarily paper) that speaks to the various stakeholders in the software development process. These stakeholders include:

-Business Partners

-Technology Partners

-External Partners (such as Vendors, Customers, Governing Authorities, etc.)

The challenge in uncovering, gathering, and documenting requirements is that each stakeholder cares about that which is important to them. Additionally, each stakeholder uses language that is unique to their perspective of the business. Creating documentation that is useful and useable by each stakeholder is difficult.

S R S

The software requirements specification (SRS) document is started after the problem analysis is complete, or at least when the problem analysis results in enough information to begin capturing certain requirements.

Davis [1993] enumerates the attributes of a well-written SRS as:

bulletCorrect
bulletUnambiguous
bulletComplete
bulletVerifiable
bulletConsistent
bulletUnderstandable by customer
bulletModifiable
bulletTraced
bulletTraceable
bulletDesign independent
bulletAnnotated
bulletConcise
bulletOrganized

There are several types of SRS frameworks that are used in various industries such as:

bullet The Naval Research Laboratory (NRL A-7E OFP SRS)
bullet The Department of Defense (DI-MCCR-80025A)
bullet NASA (SMAP-DID-P200-SW)
bullet IEEE/ANSI (830-1984)
bullet Rational Unified Process (RUP)

The IEEE/ANSI SRS is, probably, the most popular framework from which many organizations begin. That is, there is not, usually, an initial strict conformance to the document but a refinement that meets that organization's needs.

Below is a high level framework of the IEEE/ANSI SRS:

  1. Introduction
  2. bulletPurpose of SRS
    bulletScope of Product
    bulletDefinitions, Acronyms, and Abbreviations
    bulletReferences
    bulletOverview of the SRS
  3. General Description
  4. bulletProduct Perspective
    bulletProduct Functions
    bulletUser Characteristics
    bulletGeneral Constraints
    bulletAssumptions and Dependencies
  5. Specific Requirements
  6. bulletFunction Requirements
    bulletInterface Requirements
    bulletData Requirements
    bulletDesign/Implementation Constraints
  7. Non-Functional Requirements
  8. bulletSafety Requirements
    bulletSecurity
    bulletEnvironmental
    bulletComputer Resource
    bulletQuality
    bulletAvailability
  9. Appendices
  10. Index
 
Send mail to smarcus@MarcusSoftwareDesigns.com with questions or comments about this web site.
Copyright © 1998 Marcus Software Designs, Inc.
Last modified: July 14, 2006

List of Services ] Training, Seminars, and Mentoring ] Facilitation ] Requirements ] Infrastructure ]