Requirements Specification Document Organization

Requirements Specification Document Organization



Requirements specification documents are organized into sections per the standard requirements specification document outline, q.v. The following table shows the file organization for a requirements specification of typical size:
Section Contents Directory Filename
1 Introduction requirements intro
  1.1 Problem Statement requirements problem
  1.2 System Personnel requirements personnel
  1.3 Operational Setting requirements setting
  1.4 Impact Analysis requirements impacts
  1.5 Related Systems requirements related
  1.6 Feasibility Analysis requirements feasibility
2 Functional Requirements requirements functional
  2.1 User Interface Overview requirements ui-overview
  2.n Requirements Scenario N requirements [section specific]
3 Non-Functional Requirements requirements non-functional
4 System Developer Overview requirements developer-overview
5 Formal Specification specification spec
  5.n Formal Specification Module n specification [module specific]

A document (sub)section is stored in a separate file, with abbreviated mnemonic name, if one or both of the following conditions is true:

  1. sibling (sub)sections are written by different authors
  2. a (sub)section is large enough to be better managed as a separate file (approximately three pages or more)
In a document with subsections, the introductory paragraphs for the section are followed by source inclusion of the subsections. For example, the file intro contains the first paragraphs of the introduction section. The four subsections of the introduction are contained in the files users, operations, existing, and impacts; these files are source included within the intro file.

The formal specification in Section 5 is comprised of an introductory file with an overview of the modules that comprise the formal specification. This introductory file source includes the formal specification .rsl files in raw source form.