Rules on Specification contents

Specification contents is, with some exceptions, defined as everything except requirements. It is meta information found in the beginning of the document, plain text paragraphs and headings, rationales, examples, appendixes and references. The User has some possibility to define what is treated as Specification contents and what is treated as requirements contents during the analysis phase.

The following rules apply to Specification contents.

Treat rationales as requirements

All active rules on requirement level will be applied to rationales.

Treat examples as requirements

All active rules on requirement level will be applied to examples.

Spell Check

Text will be spell checked according to the language rule, i.e. U.S. English, Australian English, British English, Canadian English or Indian English.

No analysis of headings

No rules will be applied to headings. Headings are sometimes not complete sentences, and can therefore be difficult to analyze.

No analysis of references

No rules will be applied to references. References are sometimes not complete sentences, and can therefore be difficult to analyze.

Automated Readability index

Calculate the ARI index for the Specification. The index should typically have a value between 5 and 16. Higher values indicate a more complicated text, while lower values indicate a text that is more readable.

Coleman-Liau

Calculate the Coleman-Liau readability index for the Specification. The index should typically have a value between 0.4 and 16.3.

Lix

Calculate the Lix readability index for the Specification. The index should typically have a value between 34 and 57.

Kincaid

Calculate the Kincaid readability index for the Specification. The index should typically have a value between 5.5 and 16.3.

Number paragraph

Automatically number each paragraph in sequential order, starting with 1. The XML document is not edited by this rule, only the formatted Specification view will display the paragraph numbers.

Number chapters

Automatically number each chapter and sub-chapter in sequential order, starting with 1. Chapters are numbered "1", "1.1", "1.2"... The XML document is not edited by this rule, only the formatted Specification view will display the chapter numbers.

Number figures

Automatically number all figures, starting with 1. The XML document is not changed by this rule, only the formatted Specification view will display the numbers.

Number tables

Automatically number all tables, starting with 1. The XML document is not changed by this rule, only the formatted Specification view will display the numbers.

Sequences

The rule instructs the analysis engine to check the numbering sequences for all chapters, paragraphs, tables and figures. If a chapter, paragraph, table or figure identity is out of sequence, an issue will be generated. The rule is only valid for sequences that have been entered in the XML document.