Skip to main content
College of Engineering
Capstone

Software Requirements

Documenting software requirements is a critical step in the software development process. The industry standard method typically involves using a combination of techniques and documents to ensure comprehensive and clear communication of the requirements. Here’s a breakdown of the most common methods and practices:

1. Requirements Specification Documents

Software Requirements Specification (SRS)

  • Purpose: To capture all functional and non-functional requirements of the software.
  • Structure:
    • Introduction: Purpose, scope, definitions, acronyms, abbreviations, references, and overview.
    • Overall Description: Product perspective, product functions, user characteristics, constraints, assumptions, and dependencies.
    • Specific Requirements: Detailed description of functional requirements, non-functional requirements, external interface requirements, and system features.

2. User Stories and Use Cases

User Stories

  • Purpose: To describe functionalities from the end user's perspective in a simple format.
  • Format: As a [user role], I want to [goal], so that [reason].
  • Example: As a user, I want to reset my password, so that I can regain access to my account if I forget my password.

Use Cases

  • Purpose: To provide a detailed, step-by-step description of user interactions with the system.
  • Structure:
    • Use Case ID: Unique identifier.
    • Title: Descriptive title.
    • Actor: The user or system that interacts with the software.
    • Preconditions: Conditions that must be true before the use case starts.
    • Postconditions: Conditions that must be true after the use case completes.
    • Main Flow: Primary sequence of steps in the use case.
    • Alternative Flows: Variations in the main flow.

3. Functional and Non-Functional Requirements

Functional Requirements

  • Purpose: To specify what the software should do.
  • Format: Often listed in a detailed, itemized format with unique identifiers.
  • Example:
    • FR1: The system shall allow users to create accounts.
    • FR2: The system shall enable users to reset their passwords.

Non-Functional Requirements

  • Purpose: To specify the quality attributes, performance, and constraints of the software.
  • Categories: Performance, security, usability, reliability, maintainability, etc.
  • Example:
    • NFR1: The system shall handle up to 10,000 concurrent users.
    • NFR2: The system shall encrypt all sensitive data using AES-256.

4. Models and Diagrams

Unified Modeling Language (UML) Diagrams

  • Purpose: To visually represent the system and its interactions.
  • Types:
    • Use Case Diagrams: Show interactions between users and the system.
    • Class Diagrams: Show the static structure of the system.
    • Sequence Diagrams: Show how objects interact in a particular sequence.
    • Activity Diagrams: Show the workflow from one activity to another.

Data Flow Diagrams (DFD)

  • Purpose: To represent the flow of data within the system.
  • Levels: Typically include Level 0 (context diagram), Level 1, and Level 2 DFDs.

5. Requirement Traceability Matrix (RTM)

Purpose: To ensure all requirements are covered by test cases and to track the status of each requirement throughout the development lifecycle.

  • Structure:
    • Requirement ID: Unique identifier.
    • Requirement Description: Detailed description of the requirement.
    • Test Case ID: Corresponding test case identifiers.
    • Status: Current status (e.g., implemented, tested, verified).

6. Tools and Software

Requirements Management Tools

  • Examples:
    • JIRA: Popular for agile development and user story management.
    • Confluence: Often used in conjunction with JIRA for documentation and collaboration.
    • Azure DevOps: Integrated with other Microsoft tools for full lifecycle management.

By following these industry standard methods, you can ensure that your software requirements are well-documented, clear, and easily understandable by all stakeholders involved in the project.