1Requirements writing style for the Xen Hypervisor
2=================================================
3
4The requirements writing style described below is the style used for writing the
5requirements of the Xen hypervisor to enable functional safety certification.
6
7The requirements writing style is inspired from the ANSI/IEEE guide to Software
8Requirements Standard. Specifically, the requirements should satisfy the
9following validation checklist.
10(Source - https://www.nasa.gov/reference/appendix-c-how-to-write-a-good-requirement)
11
12Clarity -
13The requirements should be clear, unambiguous, consise and simple. Each
14requirement should express a single thought. Each requirement stated should have
15a single interpretation.
16
17Consistency -
18Any requirement shouldn't contradict with any other requirement. The requirements
19should be categorized correctly (the categories have been explained in the
20README). The tone of each requirement should be definitive (ie "Xen shall ..."
21should be present in each requirement).
22
23Traceability -
24Any market requirement should be linked to the product requirement/s and
25vice versa. Any product requirement should be linked to the design requirement/s
26and vice versa. Full bi-directional traceability should be maintained between
27market, product and design requirements.
28
29Correctness -
30The requirements should be feasible and technically correct (at the time of
31writing). However, it is not expected that the requirements will be kept upto
32date with the code.
33
34The requirements follow the same license and line length as the code.
35