[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH v2 3/3] docs: fusa: reqs: Added a requirements writing style guide


  • To: <sstabellini@xxxxxxxxxx>, <bertrand.marquis@xxxxxxx>, <michal.orzel@xxxxxxx>, <ayan.kumar.halder@xxxxxxx>, <artem_mygaiev@xxxxxxxx>, <julien@xxxxxxx>
  • From: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
  • Date: Fri, 2 Aug 2024 10:46:14 +0100
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=kernel.org smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0)
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=+PH+usP0G5xTrCqcAYiKhBQS5kLnoQhrAx4bS3grPWU=; b=ZLQAUaMgplfwLYT7Md7aS4xkKhkMJF/zesUwNXj/T+kqJG5trz+OV7s5qz0FoOcNLqbhGkx5vCitElBb5PgaILduSXBrv4/L5Dj5j4eg2HTYOj8S3BjRwVK/XXDQzS1G6Wukpg1nqwLIM+aqmziS8gxo3J8IGvxKLeIZzpyAQnQnbtwWgCuFgv7dHE7zjSs3KpAkqQEl7eEjHSQi3kSfNVPpIUwunnvZgDmP8AIkadBF4DMSkFZZjIf/+f3rcDk0O40SXVaQGBt9eLMRfBiKNTmNw8qDiEGQk3BSkGDAG88JvUzA8FuxGMr1hCjBQrcSBPvZo4vw0lr+QcfqzakYfw==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=qzMsOsh6m+1P9nXHgp/vZfvRcpIZ+qGnptm0MFiNMasn/ZkaKH7tVR3KVXrAFf/MZWylh4NVnTvgeu38D6Iv1fKtcpYCRy+p26siIJ0m6lELz3B088rKFPNWt87itpwLIFuEvj/NAWqIKwu70X0O37RVN9jHi/FjE2svBqDXG/1GOM46CwzNwjmEYSgeRA8adM7/j8elrMgfte58B6v5b1/y73kaw6SvvxfzXfrOQwpCcNVgfeiIcyGmLnclQKhdgYDKcmE6LNrIKBpZpBJE1aXjca6xXL2KktMD1O9u1xTFWgvsHt7VIj0r6D+/soAOGZgeTJJstVPL4WjweiiDQg==
  • Cc: <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • Delivery-date: Fri, 02 Aug 2024 09:46:37 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>

Added a guide to help write and review requirements. The requirements
are written to enable safety certification of Xen hypervisor.

Signed-off-by: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
---
Changes from :-

v1 - 1. No change.

 docs/fusa/reqs/REQUIREMENTS-STYLE | 34 +++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 docs/fusa/reqs/REQUIREMENTS-STYLE

diff --git a/docs/fusa/reqs/REQUIREMENTS-STYLE 
b/docs/fusa/reqs/REQUIREMENTS-STYLE
new file mode 100644
index 0000000000..cd2408b9f2
--- /dev/null
+++ b/docs/fusa/reqs/REQUIREMENTS-STYLE
@@ -0,0 +1,34 @@
+Requirements writing style for the Xen Hypervisor
+=================================================
+
+The requirements writing style described below is the style used for writing 
the
+requirements of the Xen hypervisor to enable functional safety certification.
+
+The requirements writing style is inspired from the ANSI/IEEE guide to Software
+Requirements Standard. Specifically, the requirements should satisfy the
+following validation checklist.
+(Source - 
https://www.nasa.gov/reference/appendix-c-how-to-write-a-good-requirement)
+
+Clarity -
+The requirements should be clear, unambiguous, consise and simple. Each
+requirement should express a single thought. Each requirement stated should 
have
+a single interpretation.
+
+Consistency -
+Any requirement shouldn't contradict with any other requirement. The 
requirements
+should be categorized correctly (the categories have been explained in the
+README). The tone of each requirement should be definitive (ie "Xen shall ..."
+should be present in each requirement).
+
+Traceability -
+Any market requirement should be linked to the product requirement/s and
+vice versa. Any product requirement should be linked to the design 
requirement/s
+and vice versa. Full bi-directional traceability should be maintained between
+market, product and design requirements.
+
+Correctness -
+The requirements should be feasible and technically correct (at the time of
+writing). However, it is not expected that the requirements will be kept upto
+date with the code.
+
+The requirements follow the same license and line length as the code.
-- 
2.25.1




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.