Specification Structure
The following issues deal with the structure of a Requirements Specification.
The specification requires a Glossary chapter.
The specification does not contain a Glossary chapter. A rule has been activated that requires a Glossary chapter to be present in the specification.
The specification does not allow Appendixes.
The specification contains one or several Appendixes. A rule has been activated that does not allow any appendixes in the specification.
Some organizations do not allow appendixes in a Requirements Specification, while others do. Appendixes can be a convenient way to store bulky information, such as large tables, long lists, figures, or layouts of reports and User interfaces. Authors can also misuse appendixes to store information that should be written as requirements.
The DTD-version is not allowed.
Each DTD (Document Type Definition) has a version number attached to it. In theory, XML documents in a project can have DTDs with different version numbers, depending on what version of rCoach One was used to develop the document. rCoach One must know the DTD-version to be able to make a correct analysis. The user must define a rule at the Specification level that describes valid DTD-versions used by the XML document.
NOTICE
Users cannot create new DTD versions on their own. If the DTD is changed by a User, the application can stop working or produce incorrect results.
Identity is out of sequence.
The identity for an element (either a chapter, paragraph, table or figure) does not follow an expected sequence. A chapter number can be out of sequence, or a table number does not follow a sequence. All sequences should follow a sorting order: ’A’ is lower than ’B’ and ’1’ is lower than ’2’.
Note that requirement tags do not need to be in sequence. They need to be unique only.
Chapter number is out of sequence.
The chapter number does not follow an expected sequence.
Chapters are numbered in the following way: "1", "2", "2.1", "2.2", "2.2.1", "2.3", "3" etc.
The following sequences will generate an issue:
- "10.2.1" followed by "10.2.1".
- "10.2.1" followed by "10.2.3"
- "10.2.2" followed by "10.2.1"
- "10.2" followed by "10.2.2"
- "10.2.1" followed by "10.4"
- "10.2" followed by "10.2.1.1"
No chapter number.
There is no chapter number. When the chapter number sequence rule is active, chapter numbers must be defined.
Chapter number is not decimal.
The chapter number is not on a decimal format. If the sequence rule is applied to an analysis, a chapter number can only contain digits separated by a punctuation character, in the following way:
- Valid chapter numbers: "1", "2", "2.1", and "2.1.1".
- Not valid chapter numbers: "C1.1", "1-1", "1:2", or "A".