Specification Structure
The following issues deal with the structure of a Requirements Specification.
Paragraph length exceeds allowed paragraph length.
The number of sentences in a single paragraph exceeds the number of allowed sentences
defined by the Specification rule. The analysis engine counts the number of sentences within <rc:para>...</rc:para> elements to decide if the rule is violated or
not.
Long paragraphs can make a specification harder to read and understand. A paragraph should normally explain a single concept.
Chapter length exceeds allowed chapter length.
The number of paragraphs in a single chapter exceeds the number of allowed paragraphs
defined by the Specification rule. The analysis engine counts the number of <rc:para>...</rc:para>
elements within the following tags:
<rc:scope><rc:general><rc:system><rc:services><rc:appendix><rc:psection><rc:rsection><rc:rationale><rc:example>
Paragraphs that are defined in nested chapters are not added to the count of the parent chapter.
A well-written Specification has clearly defined chapters that describe clearly defined subjects. Chapters that contain an excessive amount of paragraphs may treat too many subjects. The structure of a Specification can therefore benefit from smaller chapters with better-defined subjects.
Chapter depth exceeds allowed chapter depth.
The number of nested chapters exceeds the allowed number of nested chapters defined by
the Specification rule. The analysis engine counts the nesting levels for all <rc:psection> and <rc:rsection> tags within
the chapter tags listed below:
<rc:scope><rc:general><rc:system><rc:services><rc:appendix>
Specifications may be regarded as unbalanced if some chapters have a nesting level of nine while others have a nesting level of only two. An unbalanced Specification may suggest problems with the structure of the Specification, where some subjects are explored more than others.