The Structure of a Requirements Specification (part 2)
See more on the Requirements Specification structure.
Headings
Headings consist of an identity and free text. The id attribute is required, although
the value can be empty. The heading is denoted by the <rc:heading id="1"> element.
Paragraphs
A paragraph consists of free text. It is optionally followed by a bulleted list
or a
numbered list or a figure or a table. The paragraph is denoted by the <rc:para> element.
Plain text chapters
The plain text chapter consists of plain text and plain text sub-chapters. The plain
text chapter cannot contain requirements. The plain text chapter is denoted by the <rc:psection> element.
- A chapter heading
- Zero or more paragraphs
- Zero or more plain text chapters
Requirements chapters
The requirements chapter consists of plain text, rationales, requirements and
requirements sub-chapters. The requirements chapter is denoted by the <rc:rsection> element.
- A chapter heading
- Zero or more paragraphs
- A rationale (optional) with one or more requirements and zero or more requirements sub-chapters, or
- Zero or more requirements sub-chapters
Rationales
A rationale precedes a collection of requirements. The purpose is to give the reader a
context for the requirements. The rationale can explain key concepts before they are introduced in a
requirement. The rationale is denoted by the <rc:rationale>
element.
- A rationale heading (optional)
- One or more paragraphs
Definitions chapter
The Definitions chapter contains definitions that are used in the Requirements
Specification. The definitions chapter is denoted by the <rc:definitions> element.
- A chapter heading
- A paragraph (optional)
- One or more definitions, denoted by the
<rc:definition>element - A term, denoted by the
<rc:term>element. Terms describing the same definition can be separated by commas, semicolons, slashes or vertical bars. - One or more texts, denoted by the
<rc:text>element
Actors chapter
The Actors chapter defines entities that initiate system behavior. System behavior is one of two important techniques to describe a system on requirements level. The other technique is system properties and attributes.
Actors can be a human role, such as Administrator, User, or Operator; Actors can also be other parts of the system, such as the Window Manager, the Mail client, or the XML Parser. Actors can be an actor in one requirement and an Object in another. Objects are entities that are subjected to actions; objects can also possess important attributes and properties.
- A chapter heading
- One or more actors, denoted by the
<rc:actor>element. - A term, denoted by the
<rc:term>element. Terms describing the same actor can be separated by commas, semicolons, slashes or vertical bars. - One or more texts, denoted by the
<rc:text>element
Abbreviations
The abbreviations chapter contains abbreviations that are used in the Requirements
Specification. The abbreviations chapter is denoted by the <rc:abbreviations> element. The abbreviations chapter contains:
- A chapter heading
- One or more abbreviations, denoted by the
<rc:abbreviation>element - A term, denoted by the
<rc:term>element - One or more texts, denoted by the
<rc:text>element
References
The reference chapter contains references to other publications. The reference chapter
is denoted by the <rc:references> element, and contains:
- A chapter heading
- Zero or more references, denoted by the
<rc:reference>element - A reference identity, denoted by the
<rc:refid>element - One or more texts, denoted by the
<rc:text>element
Bulleted lists
Bulleted lists are denoted by <rc:bulletlist> and
consists of one or more bulleted items, denoted by a <rc:bulletitem>
element. The bulleted item consists of free text.
Numbered lists
Numbered lists are denoted by <rc:numlist> and consists
of one or more numbered items, denoted by <rc:numitem id="1">. The
numbered item consists of free text and can be numbered in any way (1, 2, 3 or i, ii, iii or a, b, c
etc.). The id attribute can also be empty or set automatically by a Specification rule.
Figures
Figures are incorporated in the Specification through the <rc:figure src="..." width="100" height="50"> element. The <rc:caption id="..."> element contains a description of the figure.
The Author needs to create the figure outside of rCoach One on a popular format, such as jpg, gif
or
tiff. Images are imported into the Specification via the XML Editor.
Tables
The table is defined through the <rc:table> element. The
table contains:
- A caption,
<rc:caption id=""> -
A table header,
<rc:tblhdr>, consisting of one or more table cells,<rc:tblcell>. - A table body,
<rc:tblbody>consisting of one or more table rows,<rc:tblrow>, where each table row consists of one or more table cells.
Requirements
Requirements consist of free text that is tagged for identity purposes. Requirements are
denoted by the <rc:requirement> element.
- A rationale (optional)
- A tag, denoted by the
<rc:tag rev="">element - One or more texts, denoted by the
<rc:text>element - A list, or table, or figure (optional)
- An example (optional)
Examples
The purpose of examples is to explain requirements that otherwise could be misunderstood.
Examples are denoted by the <rc:example> element.
- One or more paragraphs
Revision history
The Revision history is part of the document information. It provides a summary of
produced Specification revisions. The Revision history is denoted by the <rc:revhistory> element.
- A heading
- One or more revisions, denoted by the
<rc:revision>element - A revision number, denoted by the
<rc:revnumber>element - A revision date, denoted by the
<rc:date>element - Zero or more authors, denoted by the
<rc:author>element